2 * Copyright © 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.netvirt.vpnmanager;
11 import static java.util.Collections.emptyList;
12 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
14 import com.google.common.base.Optional;
15 import com.google.common.collect.Iterators;
16 import com.google.common.net.InetAddresses;
17 import com.google.common.util.concurrent.FutureCallback;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.math.BigInteger;
20 import java.net.Inet4Address;
21 import java.net.Inet6Address;
22 import java.net.InetAddress;
23 import java.net.UnknownHostException;
24 import java.text.SimpleDateFormat;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.Date;
29 import java.util.HashMap;
30 import java.util.HashSet;
31 import java.util.List;
32 import java.util.Locale;
34 import java.util.Map.Entry;
35 import java.util.Objects;
37 import java.util.concurrent.ExecutionException;
38 import java.util.concurrent.Future;
39 import java.util.function.Predicate;
40 import java.util.stream.Collectors;
41 import javax.inject.Singleton;
42 import org.eclipse.jdt.annotation.NonNull;
43 import org.eclipse.jdt.annotation.Nullable;
44 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
45 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
46 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
47 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
48 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
49 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
50 import org.opendaylight.genius.infra.Datastore;
51 import org.opendaylight.genius.infra.Datastore.Configuration;
52 import org.opendaylight.genius.infra.Datastore.Operational;
53 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
54 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
55 import org.opendaylight.genius.infra.TypedReadTransaction;
56 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
57 import org.opendaylight.genius.infra.TypedWriteTransaction;
58 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
59 import org.opendaylight.genius.mdsalutil.FlowEntity;
60 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
61 import org.opendaylight.genius.mdsalutil.InstructionInfo;
62 import org.opendaylight.genius.mdsalutil.MDSALUtil;
63 import org.opendaylight.genius.mdsalutil.MatchInfo;
64 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
65 import org.opendaylight.genius.mdsalutil.NWUtil;
66 import org.opendaylight.genius.mdsalutil.NwConstants;
67 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
68 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
69 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
70 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
71 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
72 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
73 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
74 import org.opendaylight.genius.utils.ServiceIndex;
75 import org.opendaylight.genius.utils.SystemPropertyReader;
76 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
77 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
78 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
79 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
80 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
81 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
82 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
83 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
84 import org.opendaylight.netvirt.vpnmanager.api.InterfaceUtils;
85 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
86 import org.opendaylight.netvirt.vpnmanager.api.VpnHelper;
87 import org.opendaylight.netvirt.vpnmanager.iplearn.model.MacEntry;
88 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
89 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
90 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
91 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
92 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
93 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
94 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
95 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
96 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames;
97 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
98 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
99 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
100 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
101 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
102 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
103 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
104 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.Ipv6NdUtilService;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInput;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInputBuilder;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupOutput;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockOutput;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockOutput;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOp;
162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOpBuilder;
163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventAction;
165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventData;
166 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
167 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
168 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetsAssociatedToRouteTargets;
169 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
170 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
171 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInterfaceOpData;
172 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
173 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
174 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency.AdjacencyType;
175 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
176 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
177 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
178 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
179 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEvent;
180 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventBuilder;
181 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventKey;
182 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
183 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
184 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
185 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
186 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
187 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
188 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
189 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTarget;
190 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTargetKey;
191 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnet;
192 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnetKey;
193 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpn;
194 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnBuilder;
195 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnKey;
196 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry;
197 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder;
198 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryKey;
199 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
200 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
201 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
202 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets;
203 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
204 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
205 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
206 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
207 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
208 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
209 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
210 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
211 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
212 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
213 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
214 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
215 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
216 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
217 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
218 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
219 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
220 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
221 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
222 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
223 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
224 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
225 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
226 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
227 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
228 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
229 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
230 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
231 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
232 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
233 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
234 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
235 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
236 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
237 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
238 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
239 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
240 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
241 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
242 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
243 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
244 import org.opendaylight.yangtools.yang.binding.DataObject;
245 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
246 import org.opendaylight.yangtools.yang.common.RpcResult;
247 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
248 import org.slf4j.Logger;
249 import org.slf4j.LoggerFactory;
252 public final class VpnUtil {
254 private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
256 public static final int SINGLE_TRANSACTION_BROKER_NO_RETRY = 1;
257 private static Boolean arpLearningEnabled = Boolean.TRUE;
259 private final DataBroker dataBroker;
260 private final IdManagerService idManager;
261 private final IFibManager fibManager;
262 private final IBgpManager bgpManager;
263 private final LockManagerService lockManager;
264 private final INeutronVpnManager neutronVpnService;
265 private final IMdsalApiManager mdsalManager;
266 private final IInterfaceManager interfaceManager;
267 private final JobCoordinator jobCoordinator;
268 private final ManagedNewTransactionRunner txRunner;
269 private final OdlInterfaceRpcService ifmRpcService;
272 * Class to generate timestamps with microsecond precision.
273 * For example: MicroTimestamp.INSTANCE.get() = "2012-10-21 19:13:45.267128"
275 public enum MicroTimestamp {
278 private long startDate ;
279 private long startNanoseconds ;
280 private SimpleDateFormat dateFormat ;
283 this.startDate = System.currentTimeMillis() ;
284 this.startNanoseconds = System.nanoTime() ;
285 this.dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS") ;
288 public String get() {
289 long microSeconds = (System.nanoTime() - this.startNanoseconds) / 1000 ;
290 long date = this.startDate + microSeconds / 1000 ;
291 return this.dateFormat.format(date) + String.format("%03d", microSeconds % 1000) ;
295 public VpnUtil(DataBroker dataBroker, IdManagerService idManager, IFibManager fibManager,
296 IBgpManager bgpManager, LockManagerService lockManager, INeutronVpnManager neutronVpnService,
297 IMdsalApiManager mdsalManager, JobCoordinator jobCoordinator, IInterfaceManager interfaceManager,
298 OdlInterfaceRpcService ifmRpcService) {
299 this.dataBroker = dataBroker;
300 this.idManager = idManager;
301 this.fibManager = fibManager;
302 this.bgpManager = bgpManager;
303 this.lockManager = lockManager;
304 this.neutronVpnService = neutronVpnService;
305 this.mdsalManager = mdsalManager;
306 this.interfaceManager = interfaceManager;
307 this.jobCoordinator = jobCoordinator;
308 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
309 this.ifmRpcService = ifmRpcService;
312 public static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
313 return InstanceIdentifier.builder(VpnInterfaces.class)
314 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
317 static InstanceIdentifier<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntryIdentifier(String vpnInterfaceName,
319 return InstanceIdentifier.builder(VpnInterfaceOpData.class).child(VpnInterfaceOpDataEntry.class,
320 new VpnInterfaceOpDataEntryKey(vpnInterfaceName, vpnName)).build();
323 static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
324 return InstanceIdentifier.builder(VpnInstances.class)
325 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
329 VpnInterface getVpnInterface(String vpnInterfaceName) {
330 InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
331 Optional<VpnInterface> vpnInterface = read(LogicalDatastoreType.CONFIGURATION, id);
332 return vpnInterface.isPresent() ? vpnInterface.get() : null;
335 static VpnInterfaceOpDataEntry getVpnInterfaceOpDataEntry(String intfName, String vpnName, AdjacenciesOp aug,
336 BigInteger dpnId, long lportTag,
338 return new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(intfName, vpnName))
339 .setDpnId(dpnId).addAugmentation(AdjacenciesOp.class, aug)
340 .setLportTag(lportTag).setGatewayMacAddress(gwMac).build();
343 Optional<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntry(String vpnInterfaceName, String vpnName) {
344 InstanceIdentifier<VpnInterfaceOpDataEntry> id = getVpnInterfaceOpDataEntryIdentifier(vpnInterfaceName,
346 Optional<VpnInterfaceOpDataEntry> vpnInterfaceOpDataEntry = read(LogicalDatastoreType.OPERATIONAL,
348 return vpnInterfaceOpDataEntry;
351 static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
352 return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId))
353 .child(Prefixes.class, new PrefixesKey(ipPrefix)).build();
356 static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
357 return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build();
360 static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix,
361 Uuid networkId, NetworkType networkType, Long segmentationId, Prefixes.PrefixCue prefixCue) {
362 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
363 vpnInterfaceName).setIpAddress(ipPrefix)//.setSubnetId(subnetId)
364 .setNetworkId(networkId).setNetworkType(networkType).setSegmentationId(segmentationId)
365 .setPrefixCue(prefixCue).build();
368 static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix,
369 Prefixes.PrefixCue prefixCue) {
370 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(vpnInterfaceName).setIpAddress(ipPrefix)
371 .setPrefixCue(prefixCue).build();
374 Optional<Prefixes> getPrefixToInterface(long vpnId, String ipPrefix) {
375 return read(LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
379 * Get VRF table given a Route Distinguisher.
381 * @param rd Route-Distinguisher
382 * @return VrfTables that holds the list of VrfEntries of the specified rd
385 VrfTables getVrfTable(String rd) {
386 InstanceIdentifier<VrfTables> id = InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
387 new VrfTablesKey(rd)).build();
388 Optional<VrfTables> vrfTable = read(LogicalDatastoreType.CONFIGURATION, id);
389 return vrfTable.isPresent() ? vrfTable.get() : null;
393 * Retrieves the VrfEntries that belong to a given VPN filtered out by
394 * Origin, searching by its Route-Distinguisher.
396 * @param rd Route-distinguisher of the VPN
397 * @param originsToConsider Only entries whose origin is included in this list will be considered
398 * @return the list of VrfEntries
400 public List<VrfEntry> getVrfEntriesByOrigin(String rd, List<RouteOrigin> originsToConsider) {
401 List<VrfEntry> result = new ArrayList<>();
402 List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(rd);
403 for (VrfEntry vrfEntry : allVpnVrfEntries) {
404 if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
405 result.add(vrfEntry);
412 * Retrieves all the VrfEntries that belong to a given VPN searching by its
413 * Route-Distinguisher.
415 * @param rd Route-distinguisher of the VPN
416 * @return the list of VrfEntries
418 public List<VrfEntry> getAllVrfEntries(String rd) {
419 VrfTables vrfTables = getVrfTable(rd);
420 if (vrfTables != null && vrfTables.getVrfEntry() != null) {
421 return vrfTables.getVrfEntry();
426 //FIXME: Implement caches for DS reads
428 public VpnInstance getVpnInstance(String vpnInstanceName) {
429 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
430 new VpnInstanceKey(vpnInstanceName)).build();
431 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
432 return vpnInstance.isPresent() ? vpnInstance.get() : null;
436 List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData() {
437 InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
438 Optional<VpnInstanceOpData> vpnInstanceOpDataOptional = read(LogicalDatastoreType.OPERATIONAL, id);
440 vpnInstanceOpDataOptional.isPresent() && vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry() != null
441 ? vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry()
446 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data
447 .vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(VpnInstance vpnInstance,
449 String primaryRd = getPrimaryRd(vpnInstance);
450 InstanceIdentifier<VpnToDpnList> dpnToVpnId = VpnHelper.getVpnToDpnListIdentifier(primaryRd, dpnId);
451 Optional<VpnToDpnList> dpnInVpn = read(LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
452 return dpnInVpn.isPresent() && dpnInVpn.get().getVpnInterfaces() != null ? dpnInVpn.get().getVpnInterfaces()
457 static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
458 VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
459 LOG.trace("vpnConfig {}", vpnConfig);
460 return vpnConfig.getRouteDistinguisher() != null && vpnConfig.getRouteDistinguisher() != null
461 ? vpnConfig.getRouteDistinguisher() : emptyList();
465 VrfEntry getVrfEntry(String rd, String ipPrefix) {
466 VrfTables vrfTable = getVrfTable(rd);
467 // TODO: why check VrfTables if we later go for the specific VrfEntry?
468 if (vrfTable != null) {
469 InstanceIdentifier<VrfEntry> vrfEntryId =
470 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
471 VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
472 Optional<VrfEntry> vrfEntry = read(LogicalDatastoreType.CONFIGURATION, vrfEntryId);
473 if (vrfEntry.isPresent()) {
474 return vrfEntry.get();
481 public List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(String intfName) {
482 final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
483 InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
484 Optional<Adjacencies> adjacencies = read(LogicalDatastoreType.CONFIGURATION, path);
485 if (adjacencies.isPresent()) {
486 return adjacencies.get().getAdjacency();
491 static Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
492 return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
496 String getVpnInterfaceName(BigInteger metadata) throws InterruptedException, ExecutionException {
497 GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
498 BigInteger lportTag = MetaDataUtil.getLportFromMetadata(metadata);
499 ifIndexInputBuilder.setIfIndex(lportTag.intValue());
500 GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
501 Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
502 ifmRpcService.getInterfaceFromIfIndex(input);
503 GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
504 RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
505 if (rpcResult == null) {
508 interfaceFromIfIndexOutput = rpcResult.getResult();
509 return interfaceFromIfIndexOutput.getInterfaceName();
512 static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
513 return new AllocatedRdsBuilder().withKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
516 public static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
517 return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
520 static AdjacenciesOp getVpnInterfaceOpDataEntryAugmentation(List<Adjacency> nextHopList) {
521 return new AdjacenciesOpBuilder().setAdjacency(nextHopList).build();
524 static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
525 return InstanceIdentifier.builder(Interfaces.class).child(Interface.class,
526 new InterfaceKey(interfaceName)).build();
529 public static BigInteger getCookieL3(int vpnId) {
530 return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
533 public int getUniqueId(String poolName, String idKey) {
534 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
536 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
537 RpcResult<AllocateIdOutput> rpcResult = result.get();
538 if (rpcResult.isSuccessful()) {
539 return rpcResult.getResult().getIdValue().intValue();
541 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
542 poolName, idKey, rpcResult.getErrors());
544 } catch (InterruptedException | ExecutionException e) {
545 LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
550 void releaseId(String poolName, String idKey) {
551 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
553 RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
554 if (!rpcResult.isSuccessful()) {
555 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
556 idKey, poolName, rpcResult.getErrors());
558 } catch (InterruptedException | ExecutionException e) {
559 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
563 public static String getNextHopLabelKey(String rd, String prefix) {
564 return rd + VpnConstants.SEPARATOR + prefix;
568 * Retrieves the dataplane identifier of a specific VPN, searching by its
571 * @param vpnName Name of the VPN
572 * @return the dataplane identifier of the VPN, the VrfTag.
574 public long getVpnId(String vpnName) {
575 if (vpnName == null) {
576 return VpnConstants.INVALID_ID;
579 return read(LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName))
580 .toJavaUtil().map(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
581 .vpn.instance.to.vpn.id.VpnInstance::getVpnId).orElse(VpnConstants.INVALID_ID);
585 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
587 * @param vpnName Name of the VPN
588 * @return the route-distinguisher of the VPN
590 public String getVpnRd(String vpnName) {
591 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
592 .VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION,
593 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
595 if (vpnInstance.isPresent()) {
596 rd = vpnInstance.get().getVrfId();
601 public static String getVpnRd(TypedReadTransaction<Configuration> confTx, String vpnName) {
603 return confTx.read(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName)).get().toJavaUtil().map(
604 vpnInstance -> vpnInstance.getVrfId()).orElse(null);
605 } catch (InterruptedException | ExecutionException e) {
606 throw new RuntimeException(e);
610 List<String> getVpnRdsFromVpnInstanceConfig(String vpnName) {
611 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
612 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
613 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
614 return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
618 * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
620 * @param rd Route Distinguisher
621 * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
623 public void removeVrfEntriesByOrigin(String rd, RouteOrigin origin) {
624 InstanceIdentifier<VrfTables> vpnVrfTableIid =
625 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
626 Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
627 if (vrfTablesOpc.isPresent()) {
628 VrfTables vrfTables = vrfTablesOpc.get();
629 ListenableFutures.addErrorLogging(
630 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
631 Datastore.CONFIGURATION, tx -> {
632 for (VrfEntry vrfEntry : vrfTables.nonnullVrfEntry()) {
633 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
634 tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
637 }), LOG, "Error removing VRF entries by origin");
641 public List<VrfEntry> findVrfEntriesByNexthop(String rd, String nexthop) {
642 InstanceIdentifier<VrfTables> vpnVrfTableIid =
643 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
644 Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
645 List<VrfEntry> matches = new ArrayList<>();
646 if (vrfTablesOpc.isPresent()) {
647 VrfTables vrfTables = vrfTablesOpc.get();
648 for (VrfEntry vrfEntry : vrfTables.nonnullVrfEntry()) {
649 vrfEntry.nonnullRoutePaths().stream()
650 .filter(routePath -> routePath.getNexthopAddress() != null && routePath.getNexthopAddress()
651 .equals(nexthop)).findFirst().ifPresent(routePath -> matches.add(vrfEntry));
657 public void removeVrfEntries(String rd, List<VrfEntry> vrfEntries) {
658 InstanceIdentifier<VrfTables> vpnVrfTableIid =
659 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
660 ListenableFutures.addErrorLogging(
661 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
662 Datastore.CONFIGURATION, tx -> {
663 for (VrfEntry vrfEntry : vrfEntries) {
664 tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
666 }), LOG, "Error removing VRF entries");
669 // TODO Clean up the exception handling
670 @SuppressWarnings("checkstyle:IllegalCatch")
671 public void withdrawRoutes(String rd, List<VrfEntry> vrfEntries) {
672 vrfEntries.forEach(vrfEntry -> {
674 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
675 } catch (Exception e) {
676 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
677 vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
682 public boolean removeOrUpdateDSForExtraRoute(String vpnName, String primaryRd, String extraRouteRd,
683 String vpnInterfaceName, String prefix, String nextHop,
684 String nextHopTunnelIp, TypedWriteTransaction<Operational> operTx) {
685 LOG.info("removeOrUpdateDSForExtraRoute: VPN WITHDRAW: Removing Fib Entry rd {} prefix {} nexthop {}",
686 extraRouteRd, prefix, nextHop);
687 boolean areNextHopsClearedForRd = false;
688 Optional<Routes> optVpnExtraRoutes = VpnExtraRouteHelper
689 .getVpnExtraroutes(dataBroker, vpnName, extraRouteRd, prefix);
690 if (optVpnExtraRoutes.isPresent()) {
691 List<String> nhList = optVpnExtraRoutes.get().getNexthopIpList();
692 if (nhList != null && nhList.size() > 1) {
693 // If nhList is more than 1, just update vpntoextraroute and prefixtointerface DS
694 // For other cases, remove the corresponding tep ip from fibentry and withdraw prefix
695 nhList.remove(nextHop);
696 syncWrite(LogicalDatastoreType.OPERATIONAL,
697 VpnExtraRouteHelper.getVpnToExtrarouteVrfIdIdentifier(vpnName, extraRouteRd, prefix),
698 VpnUtil.getVpnToExtraroute(prefix, nhList));
699 MDSALUtil.syncDelete(dataBroker,
700 LogicalDatastoreType.CONFIGURATION, VpnExtraRouteHelper.getUsedRdsIdentifier(getVpnId(vpnName),
702 LOG.debug("removeOrUpdateDSForExtraRoute: Removed vpn-to-extraroute with rd {} prefix {} nexthop {}",
703 extraRouteRd, prefix, nextHop);
704 fibManager.refreshVrfEntry(primaryRd, prefix);
705 operTx.delete(VpnUtil.getVpnInterfaceOpDataEntryAdjacencyIdentifier(vpnInterfaceName, vpnName, prefix));
706 LOG.info("VPN WITHDRAW: removeOrUpdateDSForExtraRoute: Removed Fib Entry rd {} prefix {} nexthop {}",
707 extraRouteRd, prefix, nextHopTunnelIp);
708 areNextHopsClearedForRd = true;
711 return areNextHopsClearedForRd;
714 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
715 getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
716 return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
720 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
721 getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
722 return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
723 .VpnIdsBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn)
728 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
729 .vpn.instance.VpnIds> getVpnIdToVpnInstanceIdentifier(long vpnId) {
730 return InstanceIdentifier.builder(VpnIdToVpnInstance.class).child(org.opendaylight.yang.gen.v1.urn
731 .opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds.class,
732 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
733 .VpnIdsKey(vpnId)).build();
737 * Retrieves the Vpn Name searching by its VPN Tag.
739 * @param vpnId Dataplane identifier of the VPN
740 * @return the Vpn instance name
743 String getVpnName(long vpnId) {
745 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
746 .instance.VpnIds> id = getVpnIdToVpnInstanceIdentifier(vpnId);
747 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
749 = read(LogicalDatastoreType.CONFIGURATION, id);
750 String vpnName = null;
751 if (vpnInstance.isPresent()) {
752 vpnName = vpnInstance.get().getVpnInstanceName();
757 public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
758 return InstanceIdentifier.builder(VpnInstanceOpData.class)
759 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
763 public VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
764 return read(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(rd)).orNull();
768 VpnInterface getConfiguredVpnInterface(String interfaceName) {
769 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
770 Optional<VpnInterface> configuredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
771 if (configuredVpnInterface.isPresent()) {
772 return configuredVpnInterface.get();
777 boolean isVpnInterfaceConfigured(String interfaceName) {
778 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
779 return read(LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
782 public Optional<List<String>> getVpnHandlingIpv4AssociatedWithInterface(String interfaceName) {
783 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
784 Optional<List<String>> vpnOptional = Optional.absent();
785 Optional<VpnInterface> optConfiguredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
786 if (optConfiguredVpnInterface.isPresent()) {
787 VpnInterface cfgVpnInterface = optConfiguredVpnInterface.get();
788 java.util.Optional<List<VpnInstanceNames>> optVpnInstanceList =
789 java.util.Optional.ofNullable(cfgVpnInterface.getVpnInstanceNames());
790 if (optVpnInstanceList.isPresent()) {
791 List<String> vpnList = new ArrayList<>();
792 for (VpnInstanceNames vpnInstance : optVpnInstanceList.get()) {
793 vpnList.add(vpnInstance.getVpnName());
795 vpnOptional = Optional.of(vpnList);
801 public static String getIpPrefix(String prefix) {
802 return prefix.indexOf('/') != -1 ? prefix : NWUtil.toIpPrefix(prefix);
805 static final FutureCallback<Void> DEFAULT_CALLBACK =
806 new FutureCallback<Void>() {
808 public void onSuccess(Void result) {
809 LOG.debug("Success in Datastore operation");
813 public void onFailure(Throwable error) {
814 LOG.error("Error in Datastore operation", error);
820 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
822 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
823 } catch (ReadFailedException e) {
824 throw new RuntimeException(e);
829 public <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
832 SingleTransactionDataBroker.syncWrite(dataBroker, datastoreType, path, data);
833 } catch (TransactionCommitFailedException e) {
834 LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data, e);
835 throw new RuntimeException(e.getMessage(), e);
840 public <T extends DataObject> void syncUpdate(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
843 SingleTransactionDataBroker.syncUpdate(dataBroker, datastoreType, path, data);
844 } catch (TransactionCommitFailedException e) {
845 LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data, e);
846 throw new RuntimeException(e.getMessage(), e);
850 static long getRemoteBCGroup(long elanTag) {
851 return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
854 // interface-index-tag operational container
856 IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
857 InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
858 Optional<IfIndexInterface> existingInterfaceInfo = read(LogicalDatastoreType.OPERATIONAL, interfaceId);
859 if (existingInterfaceInfo.isPresent()) {
860 return existingInterfaceInfo.get();
865 static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
866 return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
867 new IfIndexInterfaceKey((int) interfaceTag)).build();
871 ElanTagName getElanInfoByElanTag(long elanTag) {
872 InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
873 Optional<ElanTagName> existingElanInfo = read(LogicalDatastoreType.OPERATIONAL, elanId);
874 if (existingElanInfo.isPresent()) {
875 return existingElanInfo.get();
880 static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
881 return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
882 new ElanTagNameKey(elanTag)).build();
885 static void removePrefixToInterfaceForVpnId(long vpnId, @NonNull TypedWriteTransaction<Operational> operTx) {
886 // Clean up PrefixToInterface Operational DS
887 operTx.delete(InstanceIdentifier.builder(
888 PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build());
891 static void removeVpnExtraRouteForVpn(String vpnName, @NonNull TypedWriteTransaction<Operational> operTx) {
892 // Clean up VPNExtraRoutes Operational DS
893 operTx.delete(InstanceIdentifier.builder(VpnToExtraroutes.class).child(Vpn.class, new VpnKey(vpnName)).build());
896 @SuppressWarnings("checkstyle:IllegalCatch")
897 static void removeVpnOpInstance(String vpnName, @NonNull TypedWriteTransaction<Operational> operTx) {
898 // Clean up VPNInstanceOpDataEntry
899 operTx.delete(getVpnInstanceOpDataIdentifier(vpnName));
902 static void removeVpnInstanceToVpnId(String vpnName, @NonNull TypedWriteTransaction<Configuration> confTx) {
903 confTx.delete(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
906 static void removeVpnIdToVpnInstance(long vpnId, @NonNull TypedWriteTransaction<Configuration> confTx) {
907 confTx.delete(getVpnIdToVpnInstanceIdentifier(vpnId));
910 static void removeL3nexthopForVpnId(long vpnId, @NonNull TypedWriteTransaction<Operational> operTx) {
911 // Clean up L3NextHop Operational DS
912 operTx.delete(InstanceIdentifier.builder(L3nexthop.class).child(
913 VpnNexthops.class, new VpnNexthopsKey(vpnId)).build());
916 void scheduleVpnInterfaceForRemoval(String interfaceName, BigInteger dpnId, String vpnInstanceName,
917 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
918 InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
919 getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
920 VpnInterfaceOpDataEntry interfaceToUpdate =
921 new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(interfaceName,
922 vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
924 if (writeOperTxn != null) {
925 writeOperTxn.merge(interfaceId, interfaceToUpdate, true);
927 syncUpdate(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
931 public void createLearntVpnVipToPort(String vpnName, String fixedIp, String portName, String macAddress,
932 TypedWriteTransaction<Operational> writeOperTxn) {
933 synchronized ((vpnName + fixedIp).intern()) {
934 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
935 LearntVpnVipToPortBuilder builder =
936 new LearntVpnVipToPortBuilder().withKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
937 vpnName).setPortFixedip(fixedIp).setPortName(portName)
938 .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
939 .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
940 if (writeOperTxn != null) {
941 writeOperTxn.put(id, builder.build(), true);
943 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
945 LOG.debug("createLearntVpnVipToPort: ARP/NA learned for fixedIp: {}, vpn {}, interface {}, mac {},"
946 + " added to LearntVpnVipToPort DS", fixedIp, vpnName, portName, macAddress);
950 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
952 return InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
953 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
956 void removeLearntVpnVipToPort(String vpnName, String fixedIp,
957 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
958 synchronized ((vpnName + fixedIp).intern()) {
959 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
960 if (writeOperTxn != null) {
961 writeOperTxn.delete(id);
963 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
965 LOG.debug("removeLearntVpnVipToPort: Deleted LearntVpnVipToPort entry for fixedIp: {}, vpn {}",
970 protected static void removeVpnPortFixedIpToPort(DataBroker broker, String vpnName, String fixedIp,
971 @Nullable TypedWriteTransaction<Configuration> writeConfigTxn) {
972 synchronized ((vpnName + fixedIp).intern()) {
973 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
974 if (writeConfigTxn != null) {
975 writeConfigTxn.delete(id);
977 MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, id);
979 LOG.debug("removeVpnPortFixedIpToPort: Deleted VpnPortipToPort entry for fixedIp: {}, vpn {}",
984 public void createLearntVpnVipToPortEvent(String vpnName, String srcIp, String destIP, String portName,
985 String macAddress, LearntVpnVipToPortEventAction action,
986 TypedWriteTransaction<Operational> writeOperTxn) {
987 String eventId = MicroTimestamp.INSTANCE.get();
989 InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
990 LearntVpnVipToPortEventBuilder builder = new LearntVpnVipToPortEventBuilder().withKey(
991 new LearntVpnVipToPortEventKey(eventId)).setVpnName(vpnName).setSrcFixedip(srcIp)
992 .setDestFixedip(destIP).setPortName(portName)
993 .setMacAddress(macAddress.toLowerCase(Locale.getDefault())).setEventAction(action);
994 if (writeOperTxn != null) {
995 writeOperTxn.delete(id);
997 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
999 LOG.info("createLearntVpnVipToPortEvent: ARP learn event created for fixedIp: {}, vpn {}, interface {},"
1000 + " mac {} action {} eventId {}", srcIp, vpnName, portName, macAddress, action, eventId);
1003 private static InstanceIdentifier<LearntVpnVipToPortEvent> buildLearntVpnVipToPortEventIdentifier(String eventId) {
1004 InstanceIdentifier<LearntVpnVipToPortEvent> id = InstanceIdentifier.builder(LearntVpnVipToPortEventData.class)
1005 .child(LearntVpnVipToPortEvent.class, new LearntVpnVipToPortEventKey(eventId)).build();
1009 public void removeLearntVpnVipToPortEvent(String eventId,
1010 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
1011 InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1012 if (writeOperTxn != null) {
1013 writeOperTxn.delete(id);
1015 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1017 LOG.info("removeLearntVpnVipToPortEvent: Deleted Event {}", eventId);
1021 // TODO Clean up the exception handling
1022 @SuppressWarnings("checkstyle:IllegalCatch")
1023 public void removeMipAdjAndLearntIp(String vpnName, String vpnInterface, String prefix) {
1024 synchronized ((vpnName + prefix).intern()) {
1026 String ip = VpnUtil.getIpPrefix(prefix);
1027 InstanceIdentifier<VpnInterfaceOpDataEntry> vpnInterfaceOpId = VpnUtil
1028 .getVpnInterfaceOpDataEntryIdentifier(vpnInterface, vpnName);
1029 InstanceIdentifier<AdjacenciesOp> path = vpnInterfaceOpId.augmentation(AdjacenciesOp.class);
1030 Optional<AdjacenciesOp> adjacenciesOp = read(LogicalDatastoreType.OPERATIONAL, path);
1031 if (adjacenciesOp.isPresent()) {
1032 InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1033 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface))
1034 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ip)).build();
1035 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1036 LOG.info("removeMipAdjAndLearntIp: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1037 vpnInterface, vpnName);
1039 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, prefix);
1040 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1041 LOG.info("removeMipAdjAndLearntIp: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1042 + "VpnPortipToPort DS", prefix, vpnName);
1043 } catch (Exception e) {
1044 LOG.error("removeMipAdjAndLearntIp: Exception Deleting learned Ip: {} interface {} vpn {} from "
1045 + "LearntVpnPortipToPort DS", prefix, vpnInterface, vpnName, e);
1047 VpnUtil.removeVpnPortFixedIpToPort(dataBroker, vpnName, prefix, null);
1051 public void removeMipAdjacency(String vpnInterface, String ipAddress) {
1052 String prefix = VpnUtil.getIpPrefix(ipAddress);
1053 InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1055 SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1056 } catch (TransactionCommitFailedException e) {
1057 if (e.getCause() instanceof ModifiedNodeDoesNotExistException) {
1058 LOG.debug("vpnInterface {} is already deleted. prefix={}", vpnInterface, prefix);
1060 LOG.error("Failed to delete adjacency for vpnInterface {}, prefix {}", vpnInterface, prefix, e);
1065 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1066 return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1067 NetworkMapKey(networkId)).build();
1070 static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1071 return InstanceIdentifier.builder(SubnetOpData.class)
1072 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1075 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1076 return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1077 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1081 public VpnPortipToPort getNeutronPortFromVpnPortFixedIp(String vpnName, String fixedIp) {
1082 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1083 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
1084 if (vpnPortipToPortData.isPresent()) {
1085 return vpnPortipToPortData.get();
1091 public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(TypedReadTransaction<Configuration> confTx,
1092 String vpnName, String fixedIp) {
1093 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1095 return confTx.read(id).get().orNull();
1096 } catch (InterruptedException | ExecutionException e) {
1097 throw new RuntimeException(e);
1102 public LearntVpnVipToPort getLearntVpnVipToPort(String vpnName, String fixedIp) {
1103 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1104 Optional<LearntVpnVipToPort> learntVpnVipToPort = read(LogicalDatastoreType.OPERATIONAL, id);
1105 if (learntVpnVipToPort.isPresent()) {
1106 return learntVpnVipToPort.get();
1112 List<BigInteger> getDpnsOnVpn(String vpnInstanceName) {
1113 List<BigInteger> result = new ArrayList<>();
1114 String rd = getVpnRd(vpnInstanceName);
1116 LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1119 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1120 if (vpnInstanceOpData == null) {
1121 LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1124 List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1125 if (vpnToDpnList == null) {
1126 LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1129 for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1130 result.add(vpnToDpn.getDpnId());
1136 String getAssociatedExternalRouter(String extIp) {
1137 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1138 InstanceIdentifier.builder(ExtRouters.class).build();
1139 Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1140 if (!extRouterData.isPresent()) {
1144 // We need to find the router associated with the src ip of this packet.
1145 // This case is either SNAT, in which case the src ip is the same as the
1146 // router's external ip, or FIP in which case the src ip is in the router's
1147 // external leg's subnet. We first check the SNAT case because it is much
1148 // cheaper to do so because it does not require (potentially, there is a
1149 // cache) an datastore read of the neutron subnet for each external IP.
1151 String routerName = null;
1153 for (Routers routerData : extRouterData.get().nonnullRouters()) {
1154 List<ExternalIps> externalIps = routerData.nonnullExternalIps();
1155 for (ExternalIps externalIp : externalIps) {
1156 if (Objects.equals(externalIp.getIpAddress(), extIp)) {
1157 routerName = routerData.getRouterName();
1163 if (routerName != null) {
1167 for (Routers routerData : extRouterData.get().nonnullRouters()) {
1168 List<ExternalIps> externalIps = routerData.nonnullExternalIps();
1169 for (ExternalIps externalIp : externalIps) {
1170 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1171 if (neutronSubnet == null) {
1172 LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1173 externalIp.getSubnetId(), routerData);
1176 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp), neutronSubnet.getCidr())) {
1177 routerName = routerData.getRouterName();
1187 public String getAssociatedExternalSubnet(String extIp) {
1188 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1189 InstanceIdentifier.builder(ExtRouters.class).build();
1190 Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1191 if (!extRouterData.isPresent() || extRouterData.get().getRouters() == null) {
1194 for (Routers routerData : extRouterData.get().getRouters()) {
1195 List<ExternalIps> externalIps = routerData.getExternalIps();
1196 if (externalIps != null) {
1197 for (ExternalIps externalIp : externalIps) {
1198 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1199 if (neutronSubnet == null) {
1200 LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1201 externalIp.getSubnetId(), routerData);
1204 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp),
1205 neutronSubnet.getCidr())) {
1206 return neutronSubnet.getUuid().getValue();
1214 static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1215 return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1219 Networks getExternalNetwork(Uuid networkId) {
1220 InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1221 .child(Networks.class, new NetworksKey(networkId)).build();
1222 Optional<Networks> optionalNets = read(LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1223 return optionalNets.isPresent() ? optionalNets.get() : null;
1227 Uuid getExternalNetworkVpnId(Uuid networkId) {
1228 Networks extNetwork = getExternalNetwork(networkId);
1229 return extNetwork != null ? extNetwork.getVpnid() : null;
1233 public List<Uuid> getExternalNetworkRouterIds(Uuid networkId) {
1234 Networks extNetwork = getExternalNetwork(networkId);
1235 return extNetwork != null && extNetwork.getRouterIds() != null ? extNetwork.getRouterIds() : emptyList();
1239 Routers getExternalRouter(String routerId) {
1240 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1241 new RoutersKey(routerId)).build();
1242 Optional<Routers> routerData = read(LogicalDatastoreType.CONFIGURATION, id);
1243 return routerData.isPresent() ? routerData.get() : null;
1247 Routers getExternalRouter(TypedReadTransaction<Configuration> tx, String routerId)
1248 throws ExecutionException, InterruptedException {
1249 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1250 new RoutersKey(routerId)).build();
1251 return tx.read(id).get().orNull();
1254 static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1255 return InstanceIdentifier.create(Subnetmaps.class);
1258 FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1260 List<MatchInfo> mkMatches = new ArrayList<>();
1261 Subnetmap smap = null;
1262 mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1263 mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1264 List<InstructionInfo> mkInstructions = new ArrayList<>();
1265 mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1266 if (subnetVpnId != VpnConstants.INVALID_ID) {
1267 String vpnName = getVpnName(subnetVpnId);
1268 if (vpnName != null) {
1269 smap = getSubnetmapFromItsUuid(Uuid.getDefaultInstance(vpnName));
1270 if (smap != null && smap.getSubnetIp() != null) {
1271 IpVersionChoice ipVersionChoice = getIpVersionFromString(smap.getSubnetIp());
1272 if (ipVersionChoice == IpVersionChoice.IPV4) {
1273 mkMatches.add(MatchEthernetType.IPV4);
1275 mkMatches.add(MatchEthernetType.IPV6);
1279 BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1280 mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1282 String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress, subnetVpnId);
1283 return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1284 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1287 static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress,
1289 return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1290 + NwConstants.FLOWID_SEPARATOR + l3GwMacTable + NwConstants.FLOWID_SEPARATOR + subnetVpnId;
1293 void lockSubnet(String subnetId) {
1294 TryLockInput input =
1295 new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1296 Future<RpcResult<TryLockOutput>> result = lockManager.tryLock(input);
1298 if (result != null && result.get().isSuccessful()) {
1299 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1301 LOG.error("Unable to get lock for subnet {}", subnetId);
1302 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1304 } catch (InterruptedException | ExecutionException e) {
1305 LOG.error("Unable to get lock for subnet {}", subnetId, e);
1306 throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1310 // We store the cause, which is what we really care about
1311 @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1312 public void unlockSubnet(String subnetId) {
1313 UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1314 Future<RpcResult<UnlockOutput>> result = lockManager.unlock(input);
1316 if (result != null && result.get().isSuccessful()) {
1317 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1319 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1321 } catch (InterruptedException | ExecutionException e) {
1322 LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1323 throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1327 public Optional<IpAddress> getGatewayIpAddressFromInterface(MacEntry macEntry) {
1328 Optional<IpAddress> gatewayIp = Optional.absent();
1329 String srcInterface = macEntry.getInterfaceName();
1330 InetAddress hiddenIp = macEntry.getIpAddress();
1331 if (neutronVpnService != null) {
1332 //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1333 Port port = neutronVpnService.getNeutronPort(srcInterface);
1334 if (port != null && port.getFixedIps() != null) {
1335 for (FixedIps portIp : port.getFixedIps()) {
1336 if (doesInterfaceAndHiddenIpAddressTypeMatch(hiddenIp, portIp)) {
1338 Optional.of(neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1344 LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1345 + " Failed for interface {}.", srcInterface);
1350 private boolean doesInterfaceAndHiddenIpAddressTypeMatch(InetAddress hiddenIp, FixedIps portIp) {
1351 return hiddenIp instanceof Inet4Address && portIp.getIpAddress().getIpv4Address() != null
1352 || hiddenIp instanceof Inet6Address && portIp.getIpAddress().getIpv6Address() != null;
1355 public Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp) {
1356 Optional<String> gatewayMac = Optional.absent();
1357 long vpnId = getVpnId(macEntry.getVpnName());
1358 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1360 vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1361 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1362 vpnIdsOptional = read(LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1363 if (!vpnIdsOptional.isPresent()) {
1364 LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1367 VpnPortipToPort vpnTargetIpToPort =
1368 getNeutronPortFromVpnPortFixedIp(macEntry.getVpnName(), gatewayIp.stringValue());
1369 if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1370 gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1372 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
1373 .vpn.id.to.vpn.instance.VpnIds vpnIds = vpnIdsOptional.get();
1374 if (vpnIds.isExternalVpn()) {
1375 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1381 void setupGwMacIfExternalVpn(BigInteger dpnId, String interfaceName, long vpnId,
1382 TypedReadWriteTransaction<Configuration> writeInvTxn, int addOrRemove, String gwMac)
1383 throws ExecutionException, InterruptedException {
1384 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1385 .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1386 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1387 .VpnIds> vpnIdsOptional = writeInvTxn.read(vpnIdsInstanceIdentifier).get();
1388 if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1389 if (gwMac == null) {
1390 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1391 interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1394 FlowEntity flowEntity = buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1395 if (addOrRemove == NwConstants.ADD_FLOW) {
1396 mdsalManager.addFlow(writeInvTxn, flowEntity);
1397 } else if (addOrRemove == NwConstants.DEL_FLOW) {
1398 mdsalManager.removeFlow(writeInvTxn, flowEntity);
1403 public Optional<String> getVpnSubnetGatewayIp(final Uuid subnetUuid) {
1404 Optional<String> gwIpAddress = Optional.absent();
1405 final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1406 final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1407 .child(Subnets.class)
1408 .child(Subnet.class, subnetkey);
1409 final Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1410 if (subnet.isPresent()) {
1411 Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1412 if (IpVersionV4.class.equals(ipVersionBase)) {
1413 Subnetmap subnetmap = getSubnetmapFromItsUuid(subnetUuid);
1414 if (subnetmap != null && subnetmap.getRouterInterfaceFixedIp() != null) {
1415 LOG.trace("getVpnSubnetGatewayIp: Obtained subnetMap {} for vpn interface",
1416 subnetmap.getId().getValue());
1417 gwIpAddress = Optional.of(subnetmap.getRouterInterfaceFixedIp());
1419 //For direct L3VPN to network association (no router) continue to use subnet-gateway IP
1420 IpAddress gwIp = subnet.get().getGatewayIp();
1421 if (gwIp != null && gwIp.getIpv4Address() != null) {
1422 gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1425 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet-gw ip {} for vpn interface",
1433 RouterToNaptSwitch getRouterToNaptSwitch(String routerName) {
1434 InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1435 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1436 Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(LogicalDatastoreType.CONFIGURATION, id);
1437 return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1440 static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1441 return InstanceIdentifier.builder(Subnetmaps.class)
1442 .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1447 BigInteger getPrimarySwitchForRouter(String routerName) {
1448 RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(routerName);
1449 return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1452 static boolean isL3VpnOverVxLan(Long l3Vni) {
1453 return l3Vni != null && l3Vni != 0;
1457 * Retrieves the primary rd of a vpn instance
1458 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1459 * If rd list is empty, primary rd will be vpn instance name
1460 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1462 * @param vpnName Name of the VPN
1463 * @return the primary rd of the VPN
1465 public String getPrimaryRd(String vpnName) {
1466 // Retrieves the VPN Route Distinguisher by its Vpn instance name
1467 String rd = getVpnRd(vpnName);
1471 InstanceIdentifier<VpnInstance> id = getVpnInstanceIdentifier(vpnName);
1472 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1473 if (vpnInstance.isPresent()) {
1474 return getPrimaryRd(vpnInstance.get());
1480 * Retrieves the primary rd of a vpn instance
1481 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1482 * If rd list is empty, primary rd will be vpn instance name
1483 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1485 * @param vpnInstance Config Vpn Instance Object
1486 * @return the primary rd of the VPN
1488 static String getPrimaryRd(VpnInstance vpnInstance) {
1489 List<String> rds = null;
1490 if (vpnInstance != null) {
1491 rds = getListOfRdsFromVpnInstance(vpnInstance);
1493 return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1496 static boolean isBgpVpn(String vpnName, String primaryRd) {
1497 return !vpnName.equals(primaryRd);
1500 java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(long vpnId, @Nullable Long parentVpnId,
1501 String prefix, String vpnName,
1502 String nextHop, BigInteger dpnId) {
1503 //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1504 //This is particularly useful during reboot scenarios.
1505 java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1506 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1507 if (allocatedRd.isPresent()) {
1511 //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1512 List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1513 for (String usedRd : usedRds) {
1514 Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1515 vpnName, usedRd, prefix);
1516 if (vpnExtraRoutes.isPresent()) {
1517 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1518 // In case of VPN importing the routes, the interface is not present in the VPN
1519 // and has to be fetched from the VPN from which it imports
1520 Optional<Prefixes> prefixToInterface =
1521 getPrefixToInterface(parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1522 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1523 syncUpdate(LogicalDatastoreType.CONFIGURATION,
1524 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1525 getRdsBuilder(nextHop, usedRd).build());
1526 return java.util.Optional.of(usedRd);
1530 List<String> availableRds = getVpnRdsFromVpnInstanceConfig(vpnName);
1532 if (availableRds.isEmpty()) {
1533 rd = dpnId.toString();
1534 LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1536 LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1537 usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1538 availableRds.removeAll(usedRds);
1539 if (availableRds.isEmpty()) {
1540 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1541 return java.util.Optional.empty();
1543 // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1544 rd = availableRds.get(0);
1546 syncUpdate(LogicalDatastoreType.CONFIGURATION,
1547 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop), getRdsBuilder(nextHop, rd).build());
1548 return java.util.Optional.ofNullable(rd);
1551 static String getVpnNamePrefixKey(String vpnName, String prefix) {
1552 return vpnName + VpnConstants.SEPARATOR + prefix;
1555 static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1556 return InstanceIdentifier.builder(VpnInterfaces.class)
1557 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1558 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1561 static InstanceIdentifier<Adjacency> getVpnInterfaceOpDataEntryAdjacencyIdentifier(String intfName, String vpnName,
1563 return InstanceIdentifier.builder(VpnInterfaceOpData.class)
1564 .child(VpnInterfaceOpDataEntry.class, new VpnInterfaceOpDataEntryKey(intfName, vpnName))
1565 .augmentation(AdjacenciesOp.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1568 public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1569 if (externalIps == null) {
1573 return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1576 void bindService(final String vpnInstanceName, final String interfaceName, boolean isTunnelInterface) {
1577 jobCoordinator.enqueueJob(interfaceName,
1578 () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(
1579 Datastore.CONFIGURATION, tx -> {
1580 BoundServices serviceInfo = isTunnelInterface
1581 ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1582 : getBoundServicesForVpnInterface(vpnInstanceName, interfaceName);
1583 tx.put(InterfaceUtils.buildServiceId(interfaceName,
1584 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1585 NwConstants.L3VPN_SERVICE_INDEX)),
1586 serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1587 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1590 BoundServices getBoundServicesForVpnInterface(String vpnName, String interfaceName) {
1591 List<Instruction> instructions = new ArrayList<>();
1592 int instructionKey = 0;
1593 final long vpnId = getVpnId(vpnName);
1594 List<Action> actions = Collections.singletonList(
1595 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1596 instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1598 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1599 MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1600 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1602 BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1603 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1604 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1605 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1609 static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1610 int instructionKey = 0;
1611 List<Instruction> instructions = new ArrayList<>();
1612 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1613 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1614 BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1615 vpnName, interfaceName),
1616 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1617 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1618 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1622 void unbindService(final String vpnInterfaceName, boolean isInterfaceStateDown) {
1623 if (!isInterfaceStateDown) {
1624 jobCoordinator.enqueueJob(vpnInterfaceName,
1625 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1626 Datastore.CONFIGURATION, tx ->
1627 tx.delete(InterfaceUtils.buildServiceId(vpnInterfaceName,
1628 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1629 NwConstants.L3VPN_SERVICE_INDEX))))),
1630 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1634 static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1635 return new FlowEntityBuilder().setDpnId(dpnId).setTableId(tableId).setFlowId(flowId).build();
1638 static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1639 return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1642 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.@Nullable Subnets
1643 getExternalSubnet(Uuid subnetId) {
1644 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1645 .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1646 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1647 .Subnets.class, new SubnetsKey(subnetId)).build();
1648 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1649 optionalSubnets = read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1650 return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1654 public Uuid getSubnetFromExternalRouterByIp(Uuid routerId, String ip) {
1655 Routers externalRouter = getExternalRouter(routerId.getValue());
1656 if (externalRouter != null && externalRouter.getExternalIps() != null) {
1657 for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1658 if (Objects.equals(externalIp.getIpAddress(), ip)) {
1659 return externalIp.getSubnetId();
1666 static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1667 return vpnName.equals(subnetId);
1670 static Boolean getIsExternal(Network network) {
1671 return network.augmentation(NetworkL3Extension.class) != null
1672 && network.augmentation(NetworkL3Extension.class).isExternal();
1675 @SuppressWarnings("checkstyle:linelength")
1677 Network getNeutronNetwork(Uuid networkId) {
1678 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1679 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1680 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1681 Network.class, new NetworkKey(networkId));
1682 return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
1685 public static boolean isEligibleForBgp(@Nullable String rd, @Nullable String vpnName, @Nullable BigInteger dpnId,
1686 @Nullable String networkName) {
1688 if (rd.equals(vpnName)) {
1691 if (dpnId != null && rd.equals(dpnId.toString())) {
1694 if (rd.equals(networkName)) {
1702 static String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
1703 return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1704 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1707 void removeExternalTunnelDemuxFlows(String vpnName) {
1708 LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1709 for (BigInteger dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
1710 LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1711 String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1712 vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1713 FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1714 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1715 mdsalManager.removeFlow(flowEntity);
1719 public boolean isVpnPendingDelete(String rd) {
1720 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1721 boolean isVpnPendingDelete = false;
1722 if (vpnInstanceOpData == null
1723 || vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1724 isVpnPendingDelete = true;
1726 return isVpnPendingDelete;
1729 public List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final String vpnName) {
1730 List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1731 final String vpnRd = getVpnRd(vpnName);
1732 if (vpnRd == null) {
1733 LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1734 return vpnsToImportRoute;
1736 final VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpData(vpnRd);
1737 if (vpnInstanceOpDataEntry == null) {
1738 LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for {}"
1739 + " to check for vpns importing the routes", vpnName);
1740 return vpnsToImportRoute;
1742 Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1743 if (input.getVpnInstanceName() == null) {
1744 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1748 return !input.getVpnInstanceName().equals(vpnName);
1750 Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1751 Iterable<String> commonRTs =
1752 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1753 getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1754 return Iterators.size(commonRTs.iterator()) > 0;
1756 vpnsToImportRoute = getAllVpnInstanceOpData().stream().filter(excludeVpn).filter(matchRTs)
1757 .collect(Collectors.toList());
1758 return vpnsToImportRoute;
1761 static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1762 String name = vpnInstance.getVpnInstanceName();
1763 List<String> rts = new ArrayList<>();
1764 VpnTargets targets = vpnInstance.getVpnTargets();
1765 if (targets == null) {
1766 LOG.debug("getRts: vpn targets not available for {}", name);
1769 List<VpnTarget> vpnTargets = targets.getVpnTarget();
1770 if (vpnTargets == null) {
1771 LOG.debug("getRts: vpnTarget values not available for {}", name);
1774 for (VpnTarget target : vpnTargets) {
1775 //TODO: Check for RT type is Both
1776 if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1777 String rtValue = target.getVrfRTValue();
1784 static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1785 Set<T> intersection = new HashSet<>(collection1);
1786 intersection.retainAll(collection2);
1787 return intersection;
1790 /** Get Subnetmap from its Uuid.
1791 * @param subnetUuid the subnet's Uuid
1792 * @return the Subnetmap of Uuid or null if it is not found
1795 public Subnetmap getSubnetmapFromItsUuid(Uuid subnetUuid) {
1796 InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1797 return read(LogicalDatastoreType.CONFIGURATION, id).orNull();
1800 boolean isAdjacencyEligibleToVpnInternet(Adjacency adjacency) {
1801 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1802 boolean adjacencyEligible = false;
1803 IpVersionChoice ipVerChoice = getIpVersionFromString(adjacency.getIpAddress());
1804 if (ipVerChoice.isIpVersionChosen(IpVersionChoice.IPV6)) {
1805 Subnetmap sn = getSubnetmapFromItsUuid(adjacency.getSubnetId());
1806 if (sn != null && sn.getInternetVpnId() != null) {
1807 adjacencyEligible = true;
1810 return adjacencyEligible;
1813 boolean isAdjacencyEligibleToVpn(Adjacency adjacency, String vpnName) {
1814 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1815 boolean adjacencyEligible = true;
1816 // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1817 if (isBgpVpnInternet(vpnName)) {
1818 return isAdjacencyEligibleToVpnInternet(adjacency);
1820 return adjacencyEligible;
1824 String getInternetVpnFromVpnInstanceList(List<VpnInstanceNames> vpnInstanceList) {
1825 for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1826 String vpnName = vpnInstance.getVpnName();
1827 if (isBgpVpnInternet(vpnName)) {
1834 /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1835 * @param vpnName name of the input VPN
1836 * @return true or false
1838 boolean isBgpVpnInternet(String vpnName) {
1839 String primaryRd = getVpnRd(vpnName);
1840 if (primaryRd == null) {
1841 LOG.error("isBgpVpnInternet VPN {}."
1842 + "Primary RD not found", vpnName);
1845 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1846 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1848 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1849 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1850 LOG.error("isBgpVpnInternet VPN {}."
1851 + "VpnInstanceOpDataEntry not found", vpnName);
1854 LOG.debug("isBgpVpnInternet VPN {}."
1855 + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1856 vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1857 if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1858 .BgpvpnType.BGPVPNInternet) {
1864 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1865 * @param ipAddress String of an representation IP address V4 or V6
1866 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1868 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1869 int indexIpAddress = ipAddress.indexOf('/');
1870 if (indexIpAddress >= 0) {
1871 ipAddress = ipAddress.substring(0, indexIpAddress);
1874 InetAddress address = InetAddress.getByName(ipAddress);
1875 if (address instanceof Inet4Address) {
1876 return IpVersionChoice.IPV4;
1877 } else if (address instanceof Inet6Address) {
1878 return IpVersionChoice.IPV6;
1880 } catch (UnknownHostException | SecurityException e) {
1881 return IpVersionChoice.UNDEFINED;
1883 return IpVersionChoice.UNDEFINED;
1886 ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(String interfaceName) {
1887 VpnInterfaceBuilder builder = new VpnInterfaceBuilder().withKey(new VpnInterfaceKey(interfaceName));
1888 return txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> tx.merge(
1889 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(),
1890 WriteTransaction.CREATE_MISSING_PARENTS));
1894 * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1895 * This will create the vlan footprint in the DPN's which are member of the VPN.
1897 * @param vpnName the vpnName
1898 * @param dpnId the DPN id
1900 void addRouterPortToElanForVlanInDpn(String vpnName, BigInteger dpnId) {
1901 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1902 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1903 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1908 * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1909 * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1911 * @param vpnName the vpn name
1912 * @param dpnId the DPN id
1914 void removeRouterPortFromElanForVlanInDpn(String vpnName, BigInteger dpnId) {
1915 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1916 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1917 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1923 * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1924 * This will create the vlan footprint in all the DPN's which are member of the VPN.
1926 * @param vpnName the vpn name
1928 void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName) {
1929 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1930 Set<BigInteger> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1931 for (BigInteger dpnId : dpnList) {
1932 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1933 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1938 /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1939 * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1941 * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
1942 * @param elanInstanceName the current elanstance being removed this will be added to map for removal
1943 * @param vpnName the vpn name
1945 void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
1946 String routerInterfacePortId, String vpnName) {
1947 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1948 elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
1949 Set<BigInteger> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1950 for (BigInteger dpnId : dpnList) {
1951 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1952 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1959 Set<BigInteger> getDpnInElan(Map<String,String> elanInstanceRouterPortMap) {
1960 Set<BigInteger> dpnIdSet = new HashSet<>();
1961 for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
1962 InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
1964 Optional<ElanDpnInterfacesList> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL,
1965 elanDpnInterfaceId);
1966 if (dpnInElanInterfaces.isPresent()) {
1967 List<DpnInterfaces> dpnInterfaces = dpnInElanInterfaces.get().nonnullDpnInterfaces();
1968 for (DpnInterfaces dpnInterface : dpnInterfaces) {
1969 dpnIdSet.add(dpnInterface.getDpId());
1976 void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, BigInteger dpnId) {
1977 InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
1978 elanInstanceName,dpnId);
1979 synchronized (elanInstanceName.intern()) {
1980 Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
1981 List<String> elanInterfaceList;
1982 DpnInterfaces dpnInterface;
1983 if (!dpnInElanInterfaces.isPresent()) {
1984 elanInterfaceList = new ArrayList<>();
1986 dpnInterface = dpnInElanInterfaces.get();
1987 elanInterfaceList = dpnInterface.getInterfaces();
1989 if (!elanInterfaceList.contains(routerInterfacePortId)) {
1990 elanInterfaceList.add(routerInterfacePortId);
1991 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
1992 .withKey(new DpnInterfacesKey(dpnId)).build();
1993 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
1999 void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
2000 String vpnName, BigInteger dpnId) {
2001 InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2002 elanInstanceName,dpnId);
2003 synchronized (elanInstanceName.intern()) {
2004 Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2005 List<String> elanInterfaceList;
2006 DpnInterfaces dpnInterface;
2007 if (!dpnInElanInterfaces.isPresent()) {
2008 LOG.info("No interface in any dpn for {}", vpnName);
2011 dpnInterface = dpnInElanInterfaces.get();
2012 elanInterfaceList = dpnInterface.getInterfaces();
2014 if (!elanInterfaceList.contains(routerInterfacePortId)) {
2015 LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
2018 elanInterfaceList.remove(routerInterfacePortId);
2019 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2020 .withKey(new DpnInterfacesKey(dpnId)).build();
2021 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2027 ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
2028 InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2029 return read(LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orNull();
2032 static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2033 return InstanceIdentifier.builder(ElanInterfaces.class)
2034 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2038 DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
2039 InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2041 return read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orNull();
2045 String getExternalElanInterface(String elanInstanceName, BigInteger dpnId) {
2046 DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
2047 if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2048 LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2052 for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2053 if (interfaceManager.isExternalInterface(dpnInterface)) {
2054 return dpnInterface;
2060 static boolean isVlan(ElanInstance elanInstance) {
2061 return elanInstance != null && elanInstance.getSegmentType() != null
2062 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2063 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId() != 0;
2066 boolean isVlan(String interfaceName) {
2067 ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(interfaceName);
2068 if (elanInterface == null) {
2071 ElanInstance elanInstance = getElanInstanceByName(elanInterface.getElanInstanceName());
2072 return isVlan(elanInstance);
2076 ElanInstance getElanInstanceByName(String elanInstanceName) {
2077 InstanceIdentifier<ElanInstance> elanIdentifierId =
2078 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2079 return read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
2083 String getVpnNameFromElanIntanceName(String elanInstanceName) {
2084 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2085 if (subnetMapsData.isPresent()) {
2086 List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2087 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2088 for (Subnetmap subnet : subnetMapList) {
2089 if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2090 if (subnet.getVpnId() != null) {
2091 return subnet.getVpnId().getValue();
2100 Map<String, String> getElanInstanceRouterPortMap(String vpnName) {
2101 Map<String, String> elanInstanceRouterPortMap = new HashMap<>();
2102 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2103 if (subnetMapsData.isPresent()) {
2104 List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2105 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2106 for (Subnetmap subnet : subnetMapList) {
2107 if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2108 && NetworkType.VLAN.equals(subnet.getNetworkType())) {
2109 if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2110 LOG.warn("The RouterInterfacePortId or NetworkId is null");
2113 String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2114 if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2115 elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2121 return elanInstanceRouterPortMap;
2125 String getRouterPordIdFromElanInstance(String elanInstanceName) {
2126 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2127 if (subnetMapsData.isPresent()) {
2128 List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2129 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2130 for (Subnetmap subnet : subnetMapList) {
2131 if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2132 if (subnet.getRouterInterfacePortId() != null) {
2133 return subnet.getRouterInterfacePortId().getValue();
2142 boolean shouldPopulateFibForVlan(String vpnName, @Nullable String elanInstanceName, BigInteger dpnId) {
2143 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2144 boolean shouldPopulateFibForVlan = false;
2145 if (!elanInstanceRouterPortMap.isEmpty()) {
2146 shouldPopulateFibForVlan = true;
2148 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2150 String currentElanInstance = elanInstanceRouterEntry.getKey();
2151 if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2154 String externalinterface = getExternalElanInterface(currentElanInstance ,dpnId);
2155 if (externalinterface == null) {
2156 shouldPopulateFibForVlan = false;
2160 return shouldPopulateFibForVlan;
2163 public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2165 return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2166 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2167 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2170 public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2171 return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2172 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2176 public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2177 if (prefix != null && vpnInterface != null) {
2178 if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2179 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2180 return prefix.getDpnId().equals(vpnInterface.getDpnId())
2181 && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2188 public static void sendNeighborSolicationToOfGroup(Ipv6NdUtilService ipv6NdUtilService, Ipv6Address srcIpv6Address,
2189 MacAddress srcMac, Ipv6Address dstIpv6Address, Long ofGroupId, BigInteger dpId) {
2190 SendNeighborSolicitationToOfGroupInput input = new SendNeighborSolicitationToOfGroupInputBuilder()
2191 .setSourceIpv6(srcIpv6Address).setSourceLlAddress(srcMac).setTargetIpAddress(dstIpv6Address)
2192 .setOfGroupId(ofGroupId).setDpId(dpId).build();
2194 Future<RpcResult<SendNeighborSolicitationToOfGroupOutput>> result = ipv6NdUtilService
2195 .sendNeighborSolicitationToOfGroup(input);
2196 RpcResult<SendNeighborSolicitationToOfGroupOutput> rpcResult = result.get();
2197 if (!rpcResult.isSuccessful()) {
2198 LOG.error("sendNeighborSolicitationToOfGroup: RPC Call failed for input={} and Errors={}", input,
2199 rpcResult.getErrors());
2201 } catch (InterruptedException | ExecutionException e) {
2202 LOG.error("Failed to send NS packet to ELAN group, input={}", input, e);
2206 Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget>
2207 getRtListForVpn(String vpnName) {
2208 Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2209 .VpnTarget> rtList = new HashSet<>();
2210 InstanceIdentifier<VpnInstance> vpnInstanceId = InstanceIdentifier.builder(VpnInstances.class)
2211 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
2212 Optional<VpnInstance> vpnInstanceOptional = read(LogicalDatastoreType.CONFIGURATION, vpnInstanceId);
2213 if (vpnInstanceOptional.isPresent()) {
2214 org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.VpnTargets
2215 vpnTargets = vpnInstanceOptional.get().getIpv4Family().getVpnTargets();
2216 if (vpnTargets != null && vpnTargets.getVpnTarget() != null) {
2217 rtList.addAll(vpnTargets.getVpnTarget());
2221 LOG.error("getRtListForVpn: Vpn Instance {} not present in config DS", vpnName);
2226 static InstanceIdentifier<AssociatedVpn> getAssociatedSubnetAndVpnIdentifier(String rt, RouteTarget.RtType rtType,
2227 String cidr, String vpnName) {
2228 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2229 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr))
2230 .child(AssociatedVpn.class, new AssociatedVpnKey(vpnName)).build();
2233 static InstanceIdentifier<AssociatedSubnet> getAssociatedSubnetIdentifier(String rt, RouteTarget.RtType rtType,
2235 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2236 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr)).build();
2239 static AssociatedVpn buildAssociatedSubnetAndVpn(String vpnName) {
2240 return new AssociatedVpnBuilder().setName(vpnName).build();
2243 static InstanceIdentifier<RouteTarget> getRouteTargetsIdentifier(String rt, RouteTarget.RtType rtType) {
2244 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class)
2245 .child(RouteTarget.class, new RouteTargetKey(rt, rtType)).build();
2248 Set<RouteTarget> getRouteTargetSet(Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815
2249 .vpn.af.config.vpntargets.VpnTarget> vpnTargets) {
2250 Set<RouteTarget> routeTargetSet = new HashSet<>();
2251 for (org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2252 .VpnTarget rt : vpnTargets) {
2253 String rtValue = rt.getVrfRTValue();
2254 switch (rt.getVrfRTType()) {
2255 case ImportExtcommunity: {
2256 Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2257 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2258 if (exportRouteTargetOptional.isPresent()) {
2259 routeTargetSet.add(exportRouteTargetOptional.get());
2263 case ExportExtcommunity: {
2264 Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2265 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2266 if (importRouteTargetOptional.isPresent()) {
2267 routeTargetSet.add(importRouteTargetOptional.get());
2272 Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2273 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2274 if (exportRouteTargetOptional.isPresent()) {
2275 routeTargetSet.add(exportRouteTargetOptional.get());
2277 Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2278 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2279 if (importRouteTargetOptional.isPresent()) {
2280 routeTargetSet.add(importRouteTargetOptional.get());
2285 LOG.error("getRouteTargetSet: Invalid rt-type {}", rt.getVrfRTType());
2288 return routeTargetSet;
2292 TODO: (vivek/kiran): Subnet overlap in a VPN detection logic should use subnet allocation pools if available
2293 rather than only CIDR.
2294 Also the Subnet overlap in a VPN detection logic to be addressed for router-based-l3vpns.
2296 static boolean areSubnetsOverlapping(String cidr1, String cidr2) {
2297 final int slash1 = cidr1.indexOf('/');
2298 final int address1 = addressForCidr(cidr1, slash1);
2299 final int cidrPart1 = maskForCidr(cidr1, slash1);
2301 final int slash2 = cidr2.indexOf('/');
2302 final int address2 = addressForCidr(cidr2, slash2);
2303 final int cidrPart2 = maskForCidr(cidr2, slash2);
2305 final int comparedValue = cidrPart1 <= cidrPart2 ? compare(address1, cidrPart1, address2)
2306 : compare(address2, cidrPart2, address1);
2307 return comparedValue == 0;
2310 private static int addressForCidr(String cidr, int slash) {
2311 return InetAddresses.coerceToInteger(InetAddresses.forString(cidr.substring(0, slash)));
2314 private static int maskForCidr(String cidr, int slash) {
2315 return Integer.parseInt(cidr.substring(slash + 1));
2318 private static int compare(int address, int cidrPart, int address2) {
2319 int prefix = address2 & computeNetmask(cidrPart);
2320 return address ^ prefix;
2323 private static int computeNetmask(int cidrPart) {
2325 for (int j = 0; j < cidrPart; ++j) {
2326 netmask |= 1 << 31 - j;
2331 public static String buildIpMonitorJobKey(String ip, String vpnName) {
2332 return VpnConstants.IP_MONITOR_JOB_PREFIX_KEY + "-" + vpnName + "-" + ip;
2335 public static List<String> getVpnListForVpnInterface(VpnInterface vpnInter) {
2336 return vpnInter.nonnullVpnInstanceNames().stream()
2337 .map(VpnInstanceNames::getVpnName).collect(Collectors.toList());
2340 public void updateVpnInstanceWithRdList(String vpnName, List<String> updatedRdList) {
2341 String primaryRd = getVpnRd(vpnName);
2342 if (primaryRd == null) {
2343 LOG.warn("updateVpnInstanceWithRdList: Unable to retrieve primary RD for the VPN {}. Skip to process "
2344 + "the updated RD list {} ", vpnName, updatedRdList);
2347 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
2348 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd);
2349 builder.setRd(updatedRdList);
2350 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
2351 OPERATIONAL, tx -> {
2352 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
2353 .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
2354 new VpnInstanceOpDataEntryKey(primaryRd)).build();
2355 tx.merge(id, builder.build(), false);
2356 LOG.debug("updateVpnInstanceWithRdList: Successfully updated the VPN {} with list of RDs {}",
2357 vpnName, updatedRdList);
2362 public static RouteOrigin getRouteOrigin(AdjacencyType adjacencyType) {
2363 RouteOrigin origin = RouteOrigin.LOCAL;
2364 switch (adjacencyType) {
2365 case PrimaryAdjacency:
2366 origin = RouteOrigin.LOCAL;
2369 origin = RouteOrigin.STATIC;
2372 origin = RouteOrigin.DYNAMIC;
2375 LOG.warn("Unknown adjacencyType={}", adjacencyType);
2380 public static boolean isDualRouterVpnUpdate(List<String> oldVpnListCopy, List<String> newVpnListCopy) {
2381 return oldVpnListCopy.size() == 2 && newVpnListCopy.size() == 3
2382 || oldVpnListCopy.size() == 3 && newVpnListCopy.size() == 2;
2385 // TODO Clean up the exception handling
2386 @SuppressWarnings("checkstyle:IllegalCatch")
2387 public void createVpnPortFixedIpToPort(String vpnName, String fixedIp,
2388 String portName, boolean isLearntIp, String macAddress,
2389 WriteTransaction writeConfigTxn) {
2390 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2391 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder().withKey(new VpnPortipToPortKey(fixedIp, vpnName))
2392 .setVpnName(vpnName).setPortFixedip(fixedIp).setPortName(portName)
2393 .setLearntIp(isLearntIp).setSubnetIp(false).setMacAddress(macAddress.toLowerCase(Locale.getDefault()));
2395 if (writeConfigTxn != null) {
2396 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2398 syncWrite(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2400 LOG.trace("Port with Ip: {}, vpn {}, interface {}, learntIp {} added to VpnPortipToPort DS",
2401 fixedIp, vpnName, portName, isLearntIp);
2402 } catch (Exception e) {
2403 LOG.error("Failure while creating VpnPortIpToPort map for vpn {} learnIp{}", vpnName, fixedIp, e);
2407 protected VpnPortipToPort getVpnPortipToPort(String vpnName, String fixedIp) {
2408 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2409 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
2410 if (vpnPortipToPortData.isPresent()) {
2411 return vpnPortipToPortData.get();
2413 LOG.error("getVpnPortipToPort: Failed as vpnPortipToPortData DS is absent for VPN {} and fixed IP {}",
2418 public static void enableArpLearning(Boolean isArpLearningEnabled) {
2419 arpLearningEnabled = isArpLearningEnabled;
2422 public static Boolean isArpLearningEnabled() {
2423 return arpLearningEnabled;