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 com.google.common.base.Optional;
12 import com.google.common.collect.Iterators;
13 import com.google.common.util.concurrent.FutureCallback;
14 import com.google.common.util.concurrent.Futures;
15 import com.google.common.util.concurrent.ListenableFuture;
16 import com.google.common.util.concurrent.MoreExecutors;
17 import java.math.BigInteger;
18 import java.net.Inet4Address;
19 import java.net.Inet6Address;
20 import java.net.InetAddress;
21 import java.net.UnknownHostException;
22 import java.text.SimpleDateFormat;
23 import java.util.ArrayList;
24 import java.util.Collection;
25 import java.util.Collections;
26 import java.util.Date;
27 import java.util.HashSet;
28 import java.util.List;
29 import java.util.Locale;
31 import java.util.concurrent.ExecutionException;
32 import java.util.concurrent.Future;
33 import java.util.function.Predicate;
34 import java.util.stream.Collectors;
35 import javax.annotation.Nonnull;
36 import javax.annotation.Nullable;
37 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
38 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
39 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
40 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
41 import org.opendaylight.genius.mdsalutil.FlowEntity;
42 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
43 import org.opendaylight.genius.mdsalutil.InstructionInfo;
44 import org.opendaylight.genius.mdsalutil.MDSALDataStoreUtils;
45 import org.opendaylight.genius.mdsalutil.MDSALUtil;
46 import org.opendaylight.genius.mdsalutil.MatchInfo;
47 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
48 import org.opendaylight.genius.mdsalutil.NWUtil;
49 import org.opendaylight.genius.mdsalutil.NwConstants;
50 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
51 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
52 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
53 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
54 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
55 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
56 import org.opendaylight.genius.utils.ServiceIndex;
57 import org.opendaylight.genius.utils.SystemPropertyReader;
58 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
59 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
60 import org.opendaylight.netvirt.fibmanager.api.FibHelper;
61 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
62 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
63 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
64 import org.opendaylight.netvirt.vpnmanager.api.InterfaceUtils;
65 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
66 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
67 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
68 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
69 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
70 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
71 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
72 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
73 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
74 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames;
75 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames.AssociatedSubnetType;
76 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNamesBuilder;
77 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
78 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
79 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
80 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
81 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
82 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOp;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOpBuilder;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.RouterInterfaces;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInterfaceOpData;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency.AdjacencyType;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsBuilder;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterface;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceBuilder;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.router.interfaces.RouterInterfaceKey;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryKey;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets;
158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
166 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
167 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
168 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
169 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
170 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
171 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
172 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
173 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
174 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
175 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
176 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
177 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
178 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
179 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
180 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.RouterInterfacesMap;
181 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
182 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
183 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
184 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
185 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
186 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
187 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
188 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
189 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
190 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
191 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
192 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
193 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
194 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
195 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
196 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
197 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
198 import org.opendaylight.yangtools.yang.binding.DataObject;
199 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
200 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
201 import org.opendaylight.yangtools.yang.common.RpcResult;
202 import org.opendaylight.yangtools.yang.data.impl.schema.tree.SchemaValidationFailedException;
203 import org.slf4j.Logger;
204 import org.slf4j.LoggerFactory;
206 public final class VpnUtil {
207 private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
208 private static final int DEFAULT_PREFIX_LENGTH = 32;
209 private static final String PREFIX_SEPARATOR = "/";
214 static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
215 return InstanceIdentifier.builder(VpnInterfaces.class)
216 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
219 static InstanceIdentifier<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntryIdentifier(
220 String vpnInterfaceName, String vpnName) {
221 return InstanceIdentifier.builder(VpnInterfaceOpData.class)
222 .child(VpnInterfaceOpDataEntry.class,
223 new VpnInterfaceOpDataEntryKey(vpnInterfaceName, vpnName)).build();
226 static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
227 return InstanceIdentifier.builder(VpnInstances.class)
228 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
231 static VpnInterface getVpnInterface(DataBroker broker, String vpnInterfaceName) {
232 InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
233 Optional<VpnInterface> vpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, id);
234 return vpnInterface.isPresent() ? vpnInterface.get() : null;
237 static VpnInterfaceOpDataEntry getVpnInterfaceOpDataEntry(String intfName, String vpnName,
238 AdjacenciesOp aug, BigInteger dpnId,
239 Boolean isSheduledForRemove, long lportTag, String gwMac) {
240 return new VpnInterfaceOpDataEntryBuilder().setKey(new VpnInterfaceOpDataEntryKey(intfName, vpnName))
241 .setDpnId(dpnId).setScheduledForRemove(isSheduledForRemove).addAugmentation(AdjacenciesOp.class, aug)
242 .setLportTag(lportTag).setGatewayMacAddress(gwMac).build();
245 static Optional<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntry(DataBroker broker,
246 String vpnInterfaceName, String vpnName) {
247 InstanceIdentifier<VpnInterfaceOpDataEntry> id = getVpnInterfaceOpDataEntryIdentifier(vpnInterfaceName,
249 Optional<VpnInterfaceOpDataEntry> vpnInterfaceOpDataEntry = read(broker,
250 LogicalDatastoreType.OPERATIONAL, id);
251 return vpnInterfaceOpDataEntry;
254 static VpnInstanceNames getVpnInterfaceVpnInstanceNames(String vpnName, AssociatedSubnetType subnetType) {
255 return new VpnInstanceNamesBuilder().setVpnName(vpnName).setAssociatedSubnetType(subnetType).build();
258 static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(long vpnId, String ipPrefix) {
259 return InstanceIdentifier.builder(PrefixToInterface.class)
260 .child(VpnIds.class, new VpnIdsKey(vpnId)).child(Prefixes.class,
261 new PrefixesKey(ipPrefix)).build();
264 public static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(long vpnId) {
265 return InstanceIdentifier.builder(PrefixToInterface.class)
266 .child(VpnIds.class, new VpnIdsKey(vpnId)).build();
269 static VpnIds getPrefixToInterface(long vpnId) {
270 return new VpnIdsBuilder().setKey(new VpnIdsKey(vpnId)).setVpnId(vpnId).build();
273 static Prefixes getPrefixToInterface(BigInteger dpId, String vpnInterfaceName, String ipPrefix, Uuid subnetId,
274 Prefixes.PrefixCue prefixCue) {
275 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
276 vpnInterfaceName).setIpAddress(ipPrefix).setSubnetId(subnetId).setPrefixCue(prefixCue).build();
279 static Optional<Prefixes> getPrefixToInterface(DataBroker broker, long vpnId, String ipPrefix) {
280 return read(broker, LogicalDatastoreType.OPERATIONAL,
281 getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
285 * Get VRF table given a Route Distinguisher.
287 * @param broker dataBroker service reference
288 * @param rd Route-Distinguisher
289 * @return VrfTables that holds the list of VrfEntries of the specified rd
291 public static VrfTables getVrfTable(DataBroker broker, String rd) {
292 InstanceIdentifier<VrfTables> id =
293 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
294 Optional<VrfTables> vrfTable = read(broker, LogicalDatastoreType.CONFIGURATION, id);
295 return vrfTable.isPresent() ? vrfTable.get() : null;
299 * Retrieves the VrfEntries that belong to a given VPN filtered out by
300 * Origin, searching by its Route-Distinguisher.
302 * @param broker dataBroker service reference
303 * @param rd Route-distinguisher of the VPN
304 * @param originsToConsider Only entries whose origin is included in this list will be considered
305 * @return the list of VrfEntries
307 public static List<VrfEntry> getVrfEntriesByOrigin(DataBroker broker, String rd,
308 List<RouteOrigin> originsToConsider) {
309 List<VrfEntry> result = new ArrayList<>();
310 List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(broker, rd);
311 for (VrfEntry vrfEntry : allVpnVrfEntries) {
312 if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
313 result.add(vrfEntry);
319 static List<Prefixes> getAllPrefixesToInterface(DataBroker broker, long vpnId) {
320 Optional<VpnIds> vpnIds = read(broker, LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId));
321 if (vpnIds.isPresent()) {
322 return vpnIds.get().getPrefixes();
324 return new ArrayList<>();
328 * Retrieves all the VrfEntries that belong to a given VPN searching by its
329 * Route-Distinguisher.
331 * @param broker dataBroker service reference
332 * @param rd Route-distinguisher of the VPN
333 * @return the list of VrfEntries
335 public static List<VrfEntry> getAllVrfEntries(DataBroker broker, String rd) {
336 VrfTables vrfTables = VpnUtil.getVrfTable(broker, rd);
337 return vrfTables != null ? vrfTables.getVrfEntry() : new ArrayList<>();
340 //FIXME: Implement caches for DS reads
341 public static VpnInstance getVpnInstance(DataBroker broker, String vpnInstanceName) {
342 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
343 new VpnInstanceKey(vpnInstanceName)).build();
344 Optional<VpnInstance> vpnInstance = read(broker, LogicalDatastoreType.CONFIGURATION, id);
345 return vpnInstance.isPresent() ? vpnInstance.get() : null;
348 public static List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData(DataBroker broker) {
349 InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
350 Optional<VpnInstanceOpData> vpnInstanceOpDataOptional =
351 VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, id);
352 if (vpnInstanceOpDataOptional.isPresent()) {
353 return vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry();
355 return new ArrayList<>();
359 public static List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn
360 .instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(DataBroker broker,
361 VpnInstance vpnInstance, BigInteger dpnId) {
362 String primaryRd = getPrimaryRd(vpnInstance);
363 InstanceIdentifier<VpnToDpnList> dpnToVpnId = getVpnToDpnListIdentifier(primaryRd, dpnId);
364 Optional<VpnToDpnList> dpnInVpn = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
365 return dpnInVpn.isPresent() ? dpnInVpn.get().getVpnInterfaces() : Collections.emptyList();
368 public static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
369 VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
370 LOG.trace("vpnConfig {}", vpnConfig);
371 return vpnConfig.getRouteDistinguisher() != null ? new ArrayList<>(
372 vpnConfig.getRouteDistinguisher()) : new ArrayList<>();
375 static VrfEntry getVrfEntry(DataBroker broker, String rd, String ipPrefix) {
377 VrfTables vrfTable = getVrfTable(broker, rd);
378 // TODO: why check VrfTables if we later go for the specific VrfEntry?
379 if (vrfTable != null) {
380 InstanceIdentifier<VrfEntry> vrfEntryId =
381 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
382 VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
383 Optional<VrfEntry> vrfEntry = read(broker, LogicalDatastoreType.CONFIGURATION, vrfEntryId);
384 if (vrfEntry.isPresent()) {
385 return vrfEntry.get();
391 static List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(DataBroker broker, String intfName) {
392 final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
393 InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
394 Optional<Adjacencies> adjacencies = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, path);
396 if (adjacencies.isPresent()) {
397 List<Adjacency> nextHops = adjacencies.get().getAdjacency();
403 static Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
404 return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
407 static String getVpnInterfaceName(OdlInterfaceRpcService odlInterfaceRpcService, BigInteger metadata)
408 throws InterruptedException, ExecutionException {
409 GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
410 BigInteger lportTag = MetaDataUtil.getLportFromMetadata(metadata);
411 ifIndexInputBuilder.setIfIndex(lportTag.intValue());
412 GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
413 Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
414 odlInterfaceRpcService.getInterfaceFromIfIndex(input);
415 GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
416 RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
417 if (rpcResult == null) {
420 interfaceFromIfIndexOutput = rpcResult.getResult();
421 return interfaceFromIfIndexOutput.getInterfaceName();
424 static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
425 return new AllocatedRdsBuilder().setKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
428 static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
429 return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
432 static AdjacenciesOp getVpnInterfaceOpDataEntryAugmentation(List<Adjacency> nextHopList) {
433 return new AdjacenciesOpBuilder().setAdjacency(nextHopList).build();
436 public static InstanceIdentifier<IdPool> getPoolId(String poolName) {
437 InstanceIdentifier.InstanceIdentifierBuilder<IdPool> idBuilder =
438 InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName));
439 return idBuilder.build();
442 static InstanceIdentifier<VpnInterfaces> getVpnInterfacesIdentifier() {
443 return InstanceIdentifier.builder(VpnInterfaces.class).build();
446 static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
447 return InstanceIdentifier.builder(Interfaces.class)
448 .child(Interface.class, new InterfaceKey(interfaceName)).build();
451 static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
452 return InstanceIdentifier.builder(VpnInstanceOpData.class)
453 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
454 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
457 public static BigInteger getCookieArpFlow(int interfaceTag) {
458 return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0110000", 16)).add(
459 BigInteger.valueOf(interfaceTag));
462 public static BigInteger getCookieL3(int vpnId) {
463 return VpnConstants.COOKIE_L3_BASE.add(new BigInteger("0610000", 16)).add(BigInteger.valueOf(vpnId));
466 public static String getFlowRef(BigInteger dpnId, short tableId, int ethType, int lportTag, int arpType) {
467 return new StringBuffer().append(VpnConstants.FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
468 .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(ethType).append(lportTag)
469 .append(NwConstants.FLOWID_SEPARATOR).append(arpType).toString();
472 public static int getUniqueId(IdManagerService idManager, String poolName, String idKey) {
473 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
476 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
477 RpcResult<AllocateIdOutput> rpcResult = result.get();
478 if (rpcResult.isSuccessful()) {
479 return rpcResult.getResult().getIdValue().intValue();
481 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
482 poolName, idKey, rpcResult.getErrors());
484 } catch (InterruptedException | ExecutionException e) {
485 LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
490 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
491 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
493 Future<RpcResult<Void>> result = idManager.releaseId(idInput);
494 RpcResult<Void> rpcResult = result.get();
495 if (!rpcResult.isSuccessful()) {
496 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
497 idKey, poolName, rpcResult.getErrors());
499 } catch (InterruptedException | ExecutionException e) {
500 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
504 public static String getNextHopLabelKey(String rd, String prefix) {
505 return rd + VpnConstants.SEPARATOR + prefix;
509 * Retrieves the VpnInstance name (typically the VPN Uuid) out from the
510 * route-distinguisher.
512 * @param broker dataBroker service reference
513 * @param rd Route-Distinguisher
514 * @return the VpnInstance name
516 public static String getVpnNameFromRd(DataBroker broker, String rd) {
517 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
518 return vpnInstanceOpData != null ? vpnInstanceOpData.getVpnInstanceName() : null;
522 * Retrieves the dataplane identifier of a specific VPN, searching by its
525 * @param broker dataBroker service reference
526 * @param vpnName Name of the VPN
527 * @return the dataplane identifier of the VPN, the VrfTag.
529 public static long getVpnId(DataBroker broker, String vpnName) {
530 if (vpnName == null) {
531 return VpnConstants.INVALID_ID;
534 return read(broker, LogicalDatastoreType.CONFIGURATION,
535 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName)).toJavaUtil().map(
536 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
537 .VpnInstance::getVpnId).orElse(VpnConstants.INVALID_ID);
540 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance
541 .to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(
543 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
544 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
546 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn
553 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
555 * @param broker dataBroker service reference
556 * @param vpnName Name of the VPN
557 * @return the route-distinguisher of the VPN
559 public static String getVpnRd(DataBroker broker, String vpnName) {
560 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
563 = read(broker, LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
566 if (vpnInstance.isPresent()) {
567 rd = vpnInstance.get().getVrfId();
572 private static List<String> getVpnRdsFromVpnInstanceConfig(DataBroker broker, String vpnName) {
573 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
574 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
575 Optional<VpnInstance> vpnInstance = VpnUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
576 return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
580 * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
582 * @param broker dataBroker service reference
583 * @param rd Route Distinguisher
584 * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
586 public static void removeVrfEntriesByOrigin(DataBroker broker, String rd, RouteOrigin origin) {
587 InstanceIdentifier<VrfTables> vpnVrfTableIid =
588 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
589 Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
590 if (vrfTablesOpc.isPresent()) {
591 VrfTables vrfTables = vrfTablesOpc.get();
592 WriteTransaction tx = broker.newWriteOnlyTransaction();
593 for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
594 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
595 tx.delete(LogicalDatastoreType.CONFIGURATION,
596 vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
603 public static List<VrfEntry> findVrfEntriesByNexthop(DataBroker broker, String rd, String nexthop) {
604 InstanceIdentifier<VrfTables> vpnVrfTableIid =
605 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
606 Optional<VrfTables> vrfTablesOpc = read(broker, LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
607 List<VrfEntry> matches = new ArrayList<>();
609 if (vrfTablesOpc.isPresent()) {
610 VrfTables vrfTables = vrfTablesOpc.get();
611 for (VrfEntry vrfEntry : vrfTables.getVrfEntry()) {
612 vrfEntry.getRoutePaths().stream()
613 .filter(routePath -> routePath.getNexthopAddress() != null
614 && routePath.getNexthopAddress().equals(nexthop))
615 .findFirst().ifPresent(routePath -> matches.add(vrfEntry));
621 public static void removeVrfEntries(DataBroker broker, String rd, List<VrfEntry> vrfEntries) {
622 InstanceIdentifier<VrfTables> vpnVrfTableIid =
623 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
624 WriteTransaction tx = broker.newWriteOnlyTransaction();
625 for (VrfEntry vrfEntry : vrfEntries) {
626 tx.delete(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid.child(VrfEntry.class, vrfEntry.getKey()));
631 // TODO Clean up the exception handling
632 @SuppressWarnings("checkstyle:IllegalCatch")
633 public static void withdrawRoutes(IBgpManager bgpManager, String rd, List<VrfEntry> vrfEntries) {
634 vrfEntries.forEach(vrfEntry -> {
636 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
637 } catch (Exception e) {
638 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
639 vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
644 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
645 getVpnInstanceToVpnId(String vpnName, long vpnId, String rd) {
646 return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
650 static RouterInterface getConfiguredRouterInterface(DataBroker broker, String interfaceName) {
651 Optional<RouterInterface> optRouterInterface =
652 read(broker, LogicalDatastoreType.CONFIGURATION, VpnUtil.getRouterInterfaceId(interfaceName));
653 if (optRouterInterface.isPresent()) {
654 return optRouterInterface.get();
659 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
660 getVpnIdToVpnInstance(long vpnId, String vpnName, String rd, boolean isExternalVpn) {
661 return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
663 .setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn).build();
667 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
668 .vpn.instance.VpnIds>
669 getVpnIdToVpnInstanceIdentifier(long vpnId) {
670 return InstanceIdentifier.builder(VpnIdToVpnInstance.class)
672 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
674 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
675 .VpnIdsKey(vpnId)).build();
679 * Retrieves the Vpn Name searching by its VPN Tag.
681 * @param broker dataBroker service reference
682 * @param vpnId Dataplane identifier of the VPN
683 * @return the Vpn instance name
685 public static String getVpnName(DataBroker broker, long vpnId) {
687 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
690 = getVpnIdToVpnInstanceIdentifier(vpnId);
691 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
693 = read(broker, LogicalDatastoreType.CONFIGURATION, id);
695 String vpnName = null;
696 if (vpnInstance.isPresent()) {
697 vpnName = vpnInstance.get().getVpnInstanceName();
702 public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
703 return InstanceIdentifier.builder(VpnInstanceOpData.class)
704 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
707 static InstanceIdentifier<RouterInterface> getRouterInterfaceId(String interfaceName) {
708 return InstanceIdentifier.builder(RouterInterfaces.class)
709 .child(RouterInterface.class, new RouterInterfaceKey(interfaceName)).build();
712 static RouterInterface getRouterInterface(String interfaceName, String routerName) {
713 return new RouterInterfaceBuilder().setKey(new RouterInterfaceKey(interfaceName))
714 .setInterfaceName(interfaceName).setRouterName(routerName).build();
717 public static VpnInstanceOpDataEntry getVpnInstanceOpData(DataBroker broker, String rd) {
718 InstanceIdentifier<VpnInstanceOpDataEntry> id = VpnUtil.getVpnInstanceOpDataIdentifier(rd);
719 return read(broker, LogicalDatastoreType.OPERATIONAL, id).orNull();
722 static VpnInterface getConfiguredVpnInterface(DataBroker broker, String interfaceName) {
723 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
724 Optional<VpnInterface> configuredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId);
726 if (configuredVpnInterface.isPresent()) {
727 return configuredVpnInterface.get();
732 static String getNeutronRouterFromInterface(DataBroker broker, String interfaceName) {
733 InstanceIdentifier.InstanceIdentifierBuilder<RouterInterfacesMap> idBuilder =
734 InstanceIdentifier.builder(RouterInterfacesMap.class);
735 InstanceIdentifier<RouterInterfacesMap> id = idBuilder.build();
736 Optional<RouterInterfacesMap> routerInterfacesMap =
737 MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id);
738 if (routerInterfacesMap.isPresent()) {
739 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
741 rtrInterfaces = routerInterfacesMap.get().getRouterInterfaces();
742 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
743 .RouterInterfaces rtrInterface : rtrInterfaces) {
744 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
745 .router.interfaces.Interfaces>
746 rtrIfc = rtrInterface.getInterfaces();
747 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.router.interfaces.map
748 .router.interfaces.Interfaces ifc : rtrIfc) {
749 if (ifc.getInterfaceId().equals(interfaceName)) {
750 return rtrInterface.getRouterId().getValue();
758 static boolean isVpnInterfaceConfigured(DataBroker broker, String interfaceName) {
759 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
760 return read(broker, LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
763 static Optional<List<String>> getVpnHandlingIpv4AssociatedWithInterface(DataBroker broker, String interfaceName) {
764 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
765 Optional<List<String>> vpnOptional = Optional.absent();
766 Optional<VpnInterface> optConfiguredVpnInterface = read(broker, LogicalDatastoreType.CONFIGURATION,
768 if (optConfiguredVpnInterface.isPresent()) {
769 VpnInterface cfgVpnInterface = optConfiguredVpnInterface.get();
770 java.util.Optional<List<VpnInstanceNames>> optVpnInstanceList =
771 java.util.Optional.ofNullable(cfgVpnInterface.getVpnInstanceNames());
772 if (optVpnInstanceList.isPresent()) {
773 List<String> vpnList = new ArrayList<>();
774 for (VpnInstanceNames vpnInstance : optVpnInstanceList.get()) {
775 if (vpnInstance.getAssociatedSubnetType().equals(AssociatedSubnetType.V6Subnet)) {
778 vpnList.add(vpnInstance.getVpnName());
780 vpnOptional = Optional.of(vpnList);
786 public static String getIpPrefix(String prefix) {
787 String[] prefixValues = prefix.split("/");
788 if (prefixValues.length == 1) {
789 prefix = prefix + PREFIX_SEPARATOR + DEFAULT_PREFIX_LENGTH;
794 static final FutureCallback<Void> DEFAULT_CALLBACK =
795 new FutureCallback<Void>() {
797 public void onSuccess(Void result) {
798 LOG.debug("Success in Datastore operation");
802 public void onFailure(Throwable error) {
803 LOG.error("Error in Datastore operation", error);
808 public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
809 InstanceIdentifier<T> path) {
810 try (ReadOnlyTransaction tx = broker.newReadOnlyTransaction()) {
811 return tx.read(datastoreType, path).get();
812 } catch (InterruptedException | ExecutionException e) {
813 throw new RuntimeException(e);
817 public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
818 InstanceIdentifier<T> path, T data) {
819 asyncUpdate(broker, datastoreType, path, data, DEFAULT_CALLBACK);
822 public static <T extends DataObject> void asyncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
823 InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
824 WriteTransaction tx = broker.newWriteOnlyTransaction();
825 tx.merge(datastoreType, path, data, true);
826 Futures.addCallback(tx.submit(), callback, MoreExecutors.directExecutor());
829 public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
830 InstanceIdentifier<T> path, T data) {
831 asyncWrite(broker, datastoreType, path, data, DEFAULT_CALLBACK);
834 public static <T extends DataObject> void asyncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
835 InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
836 WriteTransaction tx = broker.newWriteOnlyTransaction();
837 tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
838 Futures.addCallback(tx.submit(), callback, MoreExecutors.directExecutor());
841 // TODO Clean up the exception handling
842 @SuppressWarnings("checkstyle:IllegalCatch")
843 public static <T extends DataObject> void tryDelete(DataBroker broker, LogicalDatastoreType datastoreType,
844 InstanceIdentifier<T> path) {
846 delete(broker, datastoreType, path, DEFAULT_CALLBACK);
847 } catch (SchemaValidationFailedException sve) {
848 LOG.info("tryDelete: Could not delete {}. SchemaValidationFailedException: {}", path, sve.getMessage());
849 } catch (Exception e) {
850 LOG.info("tryDelete: Could not delete {}. Unhandled error: {}", path, e.getMessage());
854 public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
855 InstanceIdentifier<T> path) {
856 delete(broker, datastoreType, path, DEFAULT_CALLBACK);
860 public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
861 InstanceIdentifier<T> path, FutureCallback<Void> callback) {
862 WriteTransaction tx = broker.newWriteOnlyTransaction();
863 tx.delete(datastoreType, path);
864 Futures.addCallback(tx.submit(), callback, MoreExecutors.directExecutor());
867 public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
868 InstanceIdentifier<T> path, T data) {
869 WriteTransaction tx = broker.newWriteOnlyTransaction();
870 tx.put(datastoreType, path, data, WriteTransaction.CREATE_MISSING_PARENTS);
874 } catch (InterruptedException | ExecutionException e) {
875 LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data);
876 throw new RuntimeException(e.getMessage(), e);
880 public static <T extends DataObject> void syncUpdate(DataBroker broker, LogicalDatastoreType datastoreType,
881 InstanceIdentifier<T> path, T data) {
882 WriteTransaction tx = broker.newWriteOnlyTransaction();
883 tx.merge(datastoreType, path, data, true);
887 } catch (InterruptedException | ExecutionException e) {
888 LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data);
889 throw new RuntimeException(e.getMessage(), e);
893 public static long getRemoteBCGroup(long elanTag) {
894 return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
897 // interface-index-tag operational container
898 public static IfIndexInterface getInterfaceInfoByInterfaceTag(DataBroker broker, long interfaceTag) {
899 InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
900 Optional<IfIndexInterface> existingInterfaceInfo =
901 VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
902 if (existingInterfaceInfo.isPresent()) {
903 return existingInterfaceInfo.get();
908 private static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
909 return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
910 new IfIndexInterfaceKey((int) interfaceTag)).build();
913 public static ElanTagName getElanInfoByElanTag(DataBroker broker, long elanTag) {
914 InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
915 Optional<ElanTagName> existingElanInfo = VpnUtil.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
916 if (existingElanInfo.isPresent()) {
917 return existingElanInfo.get();
922 private static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
923 return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
924 new ElanTagNameKey(elanTag)).build();
928 * Returns the Path identifier to reach a specific interface in a specific DPN in a given VpnInstance.
930 * @param vpnRd Route-Distinguisher of the VpnInstance
931 * @param dpnId Id of the DPN where the interface is
932 * @param ifaceName Interface name
933 * @return the Instance Identifier
935 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
936 .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces>
937 getVpnToDpnInterfacePath(String vpnRd, BigInteger dpnId, String ifaceName) {
940 InstanceIdentifier.builder(VpnInstanceOpData.class)
941 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(vpnRd))
942 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId))
943 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
944 .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces.class,
945 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
946 .instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfacesKey(ifaceName))
950 // TODO Clean up the exception handling
951 @SuppressWarnings("checkstyle:IllegalCatch")
952 public static void removePrefixToInterfaceForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
954 // Clean up PrefixToInterface Operational DS
955 if (writeTxn != null) {
956 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
957 InstanceIdentifier.builder(PrefixToInterface.class).child(
958 VpnIds.class, new VpnIdsKey(vpnId)).build());
960 delete(broker, LogicalDatastoreType.OPERATIONAL,
961 InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class,
962 new VpnIdsKey(vpnId)).build(),
965 } catch (Exception e) {
966 LOG.error("removePrefixToInterfaceForVpnId: Exception during cleanup of PrefixToInterface for VPN ID {}",
971 // TODO Clean up the exception handling
972 @SuppressWarnings("checkstyle:IllegalCatch")
973 public static void removeVpnExtraRouteForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
975 // Clean up VPNExtraRoutes Operational DS
976 if (writeTxn != null) {
977 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
978 InstanceIdentifier.builder(VpnToExtraroutes.class)
979 .child(Vpn.class, new VpnKey(vpnName)).build());
981 delete(broker, LogicalDatastoreType.OPERATIONAL,
982 InstanceIdentifier.builder(VpnToExtraroutes.class)
983 .child(Vpn.class, new VpnKey(vpnName)).build(),
986 } catch (Exception e) {
987 LOG.error("removeVpnExtraRouteForVpna: Exception during cleanup of VPNToExtraRoute for VPN {}",
992 // TODO Clean up the exception handling
993 @SuppressWarnings("checkstyle:IllegalCatch")
994 public static void removeVpnOpInstance(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
996 // Clean up VPNInstanceOpDataEntry
997 if (writeTxn != null) {
998 writeTxn.delete(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName));
1000 delete(broker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(vpnName),
1003 } catch (Exception e) {
1004 LOG.error("removeVpnOpInstance: Exception during cleanup of VPNInstanceOpDataEntry for VPN {}",
1009 // TODO Clean up the exception handling
1010 @SuppressWarnings("checkstyle:IllegalCatch")
1011 public static void removeVpnInstanceToVpnId(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1013 if (writeTxn != null) {
1014 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1015 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
1017 delete(broker, LogicalDatastoreType.CONFIGURATION,
1018 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName),
1021 } catch (Exception e) {
1022 LOG.error("removeVpnInstanceToVpnId: Exception during clean up of VpnInstanceToVpnId for VPN {}",
1027 // TODO Clean up the exception handling
1028 @SuppressWarnings("checkstyle:IllegalCatch")
1029 public static void removeVpnIdToVpnInstance(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1031 if (writeTxn != null) {
1032 writeTxn.delete(LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId));
1034 delete(broker, LogicalDatastoreType.CONFIGURATION, getVpnIdToVpnInstanceIdentifier(vpnId),
1037 } catch (Exception e) {
1038 LOG.error("removeVpnIdToVpnInstance: Exception during clean up of VpnIdToVpnInstance for VPNID {}",
1043 // TODO Clean up the exception handling
1044 @SuppressWarnings("checkstyle:IllegalCatch")
1045 public static void removeVrfTableForVpn(DataBroker broker, String vpnName, WriteTransaction writeTxn) {
1046 // Clean up FIB Entries Config DS
1048 if (writeTxn != null) {
1049 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1050 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1051 new VrfTablesKey(vpnName)).build());
1053 delete(broker, LogicalDatastoreType.CONFIGURATION,
1054 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
1055 new VrfTablesKey(vpnName)).build(),
1058 } catch (Exception e) {
1059 LOG.error("removeVrfTableForVpn: Exception during clean up of VrfTable from FIB for VPN {}",
1064 // TODO Clean up the exception handling
1065 @SuppressWarnings("checkstyle:IllegalCatch")
1066 public static void removeL3nexthopForVpnId(DataBroker broker, long vpnId, WriteTransaction writeTxn) {
1068 // Clean up L3NextHop Operational DS
1069 if (writeTxn != null) {
1070 writeTxn.delete(LogicalDatastoreType.OPERATIONAL,
1071 InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1072 new VpnNexthopsKey(vpnId)).build());
1074 delete(broker, LogicalDatastoreType.OPERATIONAL,
1075 InstanceIdentifier.builder(L3nexthop.class).child(VpnNexthops.class,
1076 new VpnNexthopsKey(vpnId)).build(),
1079 } catch (Exception e) {
1080 LOG.error("removeL3nexthopForVpnId: Exception during cleanup of L3NextHop for VPN ID {}", vpnId, e);
1084 public static void scheduleVpnInterfaceForRemoval(DataBroker broker,String interfaceName, BigInteger dpnId,
1085 String vpnInstanceName, Boolean isScheduledToRemove,
1086 WriteTransaction writeOperTxn) {
1087 InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
1088 VpnUtil.getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
1089 VpnInterfaceOpDataEntry interfaceToUpdate =
1090 new VpnInterfaceOpDataEntryBuilder().setKey(new VpnInterfaceOpDataEntryKey(interfaceName,
1091 vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
1092 .setScheduledForRemove(isScheduledToRemove).build();
1093 if (writeOperTxn != null) {
1094 writeOperTxn.merge(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate, true);
1096 VpnUtil.syncUpdate(broker, LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
1100 protected static void createLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp, String
1101 portName, String macAddress) {
1102 synchronized ((vpnName + fixedIp).intern()) {
1103 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1104 LearntVpnVipToPortBuilder builder =
1105 new LearntVpnVipToPortBuilder().setKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
1106 vpnName).setPortFixedip(fixedIp).setPortName(portName)
1107 .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
1108 .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
1109 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, id, builder.build());
1110 LOG.debug("createLearntVpnVipToPort: ARP learned for fixedIp: {}, vpn {}, interface {}, mac {},"
1111 + " isSubnetIp {} added to VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress);
1115 private static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
1117 InstanceIdentifier<LearntVpnVipToPort> id =
1118 InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
1119 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1123 protected static void removeLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1124 synchronized ((vpnName + fixedIp).intern()) {
1125 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1126 MDSALUtil.syncDelete(broker, LogicalDatastoreType.OPERATIONAL, id);
1127 LOG.debug("removeLearntVpnVipToPort: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1128 + " VpnPortipToPort DS", fixedIp, vpnName);
1132 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1133 return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1134 NetworkMapKey(networkId)).build();
1137 static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1138 return InstanceIdentifier.builder(SubnetOpData.class)
1139 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1142 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1143 return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1144 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1147 public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(DataBroker broker, String vpnName, String fixedIp) {
1148 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1149 Optional<VpnPortipToPort> vpnPortipToPortData = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1150 if (vpnPortipToPortData.isPresent()) {
1151 return vpnPortipToPortData.get();
1156 static LearntVpnVipToPort getLearntVpnVipToPort(DataBroker broker, String vpnName, String fixedIp) {
1157 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1158 Optional<LearntVpnVipToPort> learntVpnVipToPort = read(broker, LogicalDatastoreType.OPERATIONAL, id);
1159 if (learntVpnVipToPort.isPresent()) {
1160 return learntVpnVipToPort.get();
1166 public static List<BigInteger> getDpnsOnVpn(DataBroker dataBroker, String vpnInstanceName) {
1167 List<BigInteger> result = new ArrayList<>();
1168 String rd = getVpnRd(dataBroker, vpnInstanceName);
1170 LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1174 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(dataBroker, rd);
1175 if (vpnInstanceOpData == null) {
1176 LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1180 List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1181 if (vpnToDpnList == null) {
1182 LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1185 for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1186 result.add(vpnToDpn.getDpnId());
1191 static String getAssociatedExternalNetwork(DataBroker dataBroker, String routerId) {
1192 InstanceIdentifier<Routers> id = buildRouterIdentifier(routerId);
1193 Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1194 if (routerData.isPresent()) {
1195 Uuid networkId = routerData.get().getNetworkId();
1196 if (networkId != null) {
1197 return networkId.getValue();
1203 public static String getAssociatedExternalRouter(DataBroker dataBroker, String extIp) {
1204 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1205 InstanceIdentifier.builder(ExtRouters.class).build();
1206 Optional<ExtRouters> extRouterData = read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1207 extRouterInstanceIndentifier);
1208 if (extRouterData.isPresent()) {
1209 for (Routers routerData : extRouterData.get().getRouters()) {
1210 List<ExternalIps> externalIps = routerData.getExternalIps();
1211 for (ExternalIps externalIp : externalIps) {
1212 if (externalIp.getIpAddress().equals(extIp)) {
1213 return routerData.getRouterName();
1221 static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1222 return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1225 static Networks getExternalNetwork(DataBroker dataBroker, Uuid networkId) {
1226 InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1227 .child(Networks.class, new NetworksKey(networkId)).build();
1228 Optional<Networks> optionalNets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1229 return optionalNets.isPresent() ? optionalNets.get() : null;
1232 static Uuid getExternalNetworkVpnId(DataBroker dataBroker, Uuid networkId) {
1233 Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1234 return extNetwork != null ? extNetwork.getVpnid() : null;
1237 static List<Uuid> getExternalNetworkRouterIds(DataBroker dataBroker, Uuid networkId) {
1238 Networks extNetwork = getExternalNetwork(dataBroker, networkId);
1239 return extNetwork != null ? extNetwork.getRouterIds() : Collections.emptyList();
1242 static Routers getExternalRouter(DataBroker dataBroker, String routerId) {
1243 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class)
1244 .child(Routers.class, new RoutersKey(routerId)).build();
1245 Optional<Routers> routerData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1246 return routerData.isPresent() ? routerData.get() : null;
1249 static List<String> getAllSubnetGatewayMacAddressesforVpn(DataBroker broker, String vpnName) {
1250 List<String> macAddresses = new ArrayList<>();
1251 Optional<Subnetmaps> subnetMapsData =
1252 read(broker, LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
1253 if (subnetMapsData.isPresent()) {
1254 List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
1255 if (subnetMapList != null && !subnetMapList.isEmpty()) {
1256 for (Subnetmap subnet : subnetMapList) {
1257 if (subnet.getVpnId() != null && subnet.getVpnId().equals(Uuid.getDefaultInstance(vpnName))) {
1258 String routerIntfMacAddress = subnet.getRouterIntfMacAddress();
1259 if (routerIntfMacAddress != null && !routerIntfMacAddress.isEmpty()) {
1260 macAddresses.add(subnet.getRouterIntfMacAddress());
1266 return macAddresses;
1269 static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1270 return InstanceIdentifier.create(Subnetmaps.class);
1273 public static FlowEntity buildL3vpnGatewayFlow(BigInteger dpId, String gwMacAddress, long vpnId,
1275 List<MatchInfo> mkMatches = new ArrayList<>();
1276 mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
1277 mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1278 List<InstructionInfo> mkInstructions = new ArrayList<>();
1279 mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1280 if (subnetVpnId != VpnConstants.INVALID_ID) {
1281 BigInteger subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId);
1282 mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1285 String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress);
1287 return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1288 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE, mkMatches, mkInstructions);
1291 private static String getL3VpnGatewayFlowRef(short l3GwMacTable, BigInteger dpId, long vpnId, String gwMacAddress) {
1292 return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1293 + NwConstants.FLOWID_SEPARATOR + l3GwMacTable;
1296 public static void lockSubnet(LockManagerService lockManager, String subnetId) {
1297 TryLockInput input =
1298 new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1299 Future<RpcResult<Void>> result = lockManager.tryLock(input);
1300 String errMsg = "Unable to getLock for subnet " + subnetId;
1302 if (result != null && result.get().isSuccessful()) {
1303 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1305 throw new RuntimeException(errMsg);
1307 } catch (InterruptedException | ExecutionException e) {
1309 throw new RuntimeException(e.getMessage(), e);
1313 // We store the cause, which is what we really care about
1314 @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1315 public static void unlockSubnet(LockManagerService lockManager, String subnetId) {
1316 UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1317 Future<RpcResult<Void>> result = lockManager.unlock(input);
1319 if (result != null && result.get().isSuccessful()) {
1320 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1322 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1324 } catch (InterruptedException | ExecutionException e) {
1325 LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1326 throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1330 static Optional<IpAddress> getGatewayIpAddressFromInterface(String srcInterface,
1331 INeutronVpnManager neutronVpnService, DataBroker dataBroker) {
1332 Optional<IpAddress> gatewayIp = Optional.absent();
1333 if (neutronVpnService != null) {
1334 //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1335 Port port = neutronVpnService.getNeutronPort(srcInterface);
1336 if (port != null && port.getFixedIps() != null && port.getFixedIps().get(0) != null
1337 && port.getFixedIps().get(0).getSubnetId() != null) {
1338 gatewayIp = Optional.of(
1339 neutronVpnService.getNeutronSubnet(port.getFixedIps().get(0).getSubnetId()).getGatewayIp());
1342 LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1343 + " Failed for interface {}.", srcInterface);
1348 static Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp,
1349 DataBroker dataBroker, OdlInterfaceRpcService interfaceRpc) {
1350 Optional<String> gatewayMac = Optional.absent();
1351 long vpnId = getVpnId(dataBroker, macEntry.getVpnName());
1352 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1354 vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1355 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1357 = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1358 if (!vpnIdsOptional.isPresent()) {
1359 LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1362 VpnPortipToPort vpnTargetIpToPort = VpnUtil.getNeutronPortFromVpnPortFixedIp(dataBroker,
1363 macEntry.getVpnName(), gatewayIp.getIpv4Address().getValue());
1364 if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1365 gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1367 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds vpnIds =
1368 vpnIdsOptional.get();
1369 if (vpnIds.isExternalVpn()) {
1370 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1376 public static void setupGwMacIfExternalVpn(DataBroker dataBroker, IMdsalApiManager mdsalManager, BigInteger dpnId,
1377 String interfaceName, long vpnId, WriteTransaction writeInvTxn, int addOrRemove, String gwMac) {
1378 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1379 .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1380 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1381 .VpnIds> vpnIdsOptional = read(
1382 dataBroker, LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1383 if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1384 if (gwMac == null) {
1385 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1386 interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1389 FlowEntity flowEntity = VpnUtil.buildL3vpnGatewayFlow(dpnId, gwMac, vpnId, VpnConstants.INVALID_ID);
1390 if (addOrRemove == NwConstants.ADD_FLOW) {
1391 mdsalManager.addFlowToTx(flowEntity, writeInvTxn);
1392 } else if (addOrRemove == NwConstants.DEL_FLOW) {
1393 mdsalManager.removeFlowToTx(flowEntity, writeInvTxn);
1398 public static Optional<VpnPortipToPort> getRouterInterfaceForVpnInterface(DataBroker dataBroker,
1399 String interfaceName,
1402 Optional<VpnPortipToPort> gwPortOptional = Optional.absent();
1403 if (subnetUuid != null) {
1404 final Optional<String> gatewayIp = getVpnSubnetGatewayIp(dataBroker, subnetUuid);
1405 if (gatewayIp.isPresent()) {
1406 String gwIp = gatewayIp.get();
1407 gwPortOptional = Optional.fromNullable(getNeutronPortFromVpnPortFixedIp(dataBroker, vpnName, gwIp));
1410 return gwPortOptional;
1413 public static Optional<String> getVpnSubnetGatewayIp(DataBroker dataBroker, final Uuid subnetUuid) {
1414 Optional<String> gwIpAddress = Optional.absent();
1415 final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1416 final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1417 .child(Subnets.class)
1418 .child(Subnet.class, subnetkey);
1419 final Optional<Subnet> subnet = read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1420 if (subnet.isPresent()) {
1421 Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1422 if (ipVersionBase.equals(IpVersionV4.class)) {
1423 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet {} for vpn interface",
1424 subnet.get().getUuid().getValue());
1425 IpAddress gwIp = subnet.get().getGatewayIp();
1426 if (gwIp != null && gwIp.getIpv4Address() != null) {
1427 gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1434 public static RouterToNaptSwitch getRouterToNaptSwitch(DataBroker dataBroker, String routerName) {
1435 InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1436 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1437 Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1438 return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1441 static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1442 return InstanceIdentifier.builder(Subnetmaps.class)
1443 .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1447 public static BigInteger getPrimarySwitchForRouter(DataBroker dataBroker, String routerName) {
1448 RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(dataBroker, routerName);
1449 return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1452 static boolean isL3VpnOverVxLan(Long l3Vni) {
1453 return l3Vni != null && l3Vni != 0;
1456 static boolean isEvpnOverVxLan(Long l2Vni) { //To be used by RT2
1457 return l2Vni != null && l2Vni != 0;
1461 * Retrieves the primary rd of a vpn instance
1462 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1463 * If rd list is empty, primary rd will be vpn instance name
1464 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1466 * @param dataBroker dataBroker service reference
1467 * @param vpnName Name of the VPN
1468 * @return the primary rd of the VPN
1470 public static String getPrimaryRd(DataBroker dataBroker, String vpnName) {
1471 // Retrieves the VPN Route Distinguisher by its Vpn instance name
1472 String rd = getVpnRd(dataBroker, vpnName);
1476 InstanceIdentifier<VpnInstance> id = getVpnInstanceIdentifier(vpnName);
1477 Optional<VpnInstance> vpnInstance = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
1478 if (vpnInstance.isPresent()) {
1479 return getPrimaryRd(vpnInstance.get());
1485 * Retrieves the primary rd of a vpn instance
1486 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1487 * If rd list is empty, primary rd will be vpn instance name
1488 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1490 * @param vpnInstance Config Vpn Instance Object
1491 * @return the primary rd of the VPN
1493 public static String getPrimaryRd(VpnInstance vpnInstance) {
1494 List<String> rds = null;
1495 if (vpnInstance != null) {
1496 rds = getListOfRdsFromVpnInstance(vpnInstance);
1498 return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1501 public static boolean isBgpVpn(String vpnName, String primaryRd) {
1502 return !vpnName.equals(primaryRd);
1505 static java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(
1506 DataBroker dataBroker, long vpnId, @Nullable Long parentVpnId, String prefix, String vpnName,
1507 String nextHop, BigInteger dpnId, WriteTransaction writeOperTxn) {
1508 //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1509 //This is particularly useful during reboot scenarios.
1510 java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1511 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1512 if (allocatedRd.isPresent()) {
1513 return java.util.Optional.of(allocatedRd.get());
1516 //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1517 List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1518 for (String usedRd : usedRds) {
1519 Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1520 vpnName, usedRd, prefix);
1521 if (vpnExtraRoutes.isPresent()) {
1522 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1523 // In case of VPN importing the routes, the interface is not present in the VPN
1524 // and has to be fetched from the VPN from which it imports
1525 Optional<Prefixes> prefixToInterface =
1526 getPrefixToInterface(dataBroker, parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1527 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1528 syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1529 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1530 getRdsBuilder(nextHop, usedRd).build());
1531 return java.util.Optional.of(usedRd);
1535 List<String> availableRds = getVpnRdsFromVpnInstanceConfig(dataBroker, vpnName);
1537 if (availableRds.isEmpty()) {
1538 rd = dpnId.toString();
1539 LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1542 "Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {},"
1543 + " adj - {}", usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1544 availableRds.removeAll(usedRds);
1545 if (availableRds.isEmpty()) {
1546 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1547 return java.util.Optional.empty();
1549 // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1550 rd = availableRds.get(0);
1552 syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION,
1553 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1554 getRdsBuilder(nextHop, rd).build());
1555 return java.util.Optional.ofNullable(rd);
1558 static String getVpnNamePrefixKey(String vpnName, String prefix) {
1559 return vpnName + VpnConstants.SEPARATOR + prefix;
1562 static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1563 return InstanceIdentifier.builder(VpnInterfaces.class)
1564 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1565 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1568 public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1569 if (externalIps == null) {
1570 return Collections.emptyList();
1573 return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1576 static void bindService(final String vpnInstanceName, final String interfaceName, DataBroker dataBroker,
1577 boolean isTunnelInterface, JobCoordinator jobCoordinator) {
1578 jobCoordinator.enqueueJob(interfaceName,
1580 WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1581 BoundServices serviceInfo = isTunnelInterface
1582 ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1583 : getBoundServicesForVpnInterface(dataBroker, vpnInstanceName, interfaceName);
1584 writeTxn.put(LogicalDatastoreType.CONFIGURATION, InterfaceUtils.buildServiceId(interfaceName,
1585 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX)),
1586 serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1587 return Collections.singletonList(writeTxn.submit());
1588 }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1591 static BoundServices getBoundServicesForVpnInterface(DataBroker broker, String vpnName, String interfaceName) {
1592 List<Instruction> instructions = new ArrayList<>();
1593 int instructionKey = 0;
1594 final long vpnId = VpnUtil.getVpnId(broker, vpnName);
1595 List<Action> actions = Collections.singletonList(
1596 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId).buildAction());
1597 instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1599 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId),
1600 MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1601 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1603 BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1604 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1605 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1606 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1610 static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1611 int instructionKey = 0;
1612 List<Instruction> instructions = new ArrayList<>();
1613 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1614 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1615 BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1616 vpnName, interfaceName),
1617 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1618 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1619 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1623 static void unbindService(DataBroker dataBroker, final String vpnInterfaceName, boolean isInterfaceStateDown,
1624 JobCoordinator jobCoordinator) {
1625 if (!isInterfaceStateDown) {
1626 jobCoordinator.enqueueJob(vpnInterfaceName,
1628 WriteTransaction writeTxn = dataBroker.newWriteOnlyTransaction();
1629 writeTxn.delete(LogicalDatastoreType.CONFIGURATION,
1630 InterfaceUtils.buildServiceId(vpnInterfaceName,
1631 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1632 NwConstants.L3VPN_SERVICE_INDEX)));
1634 List<ListenableFuture<Void>> futures = new ArrayList<>();
1635 futures.add(writeTxn.submit());
1637 }, SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1641 static FlowEntity buildFlowEntity(BigInteger dpnId, short tableId, String flowId) {
1642 return new FlowEntityBuilder()
1644 .setTableId(tableId)
1649 static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1650 return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1653 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1654 .Subnets getExternalSubnet(DataBroker dataBroker, Uuid subnetId) {
1655 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1656 .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1657 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1658 .Subnets.class, new SubnetsKey(subnetId)).build();
1659 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1660 optionalSubnets = VpnUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1661 return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1664 static Uuid getSubnetFromExternalRouterByIp(DataBroker dataBroker, Uuid routerId, String ip) {
1665 Routers externalRouter = VpnUtil.getExternalRouter(dataBroker, routerId.getValue());
1666 if (externalRouter != null && externalRouter.getExternalIps() != null) {
1667 for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1668 if (externalIp.getIpAddress().equals(ip)) {
1669 return externalIp.getSubnetId();
1676 static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1677 return vpnName.equals(subnetId);
1680 static Boolean getIsExternal(Network network) {
1681 return network.getAugmentation(NetworkL3Extension.class) != null
1682 && network.getAugmentation(NetworkL3Extension.class).isExternal();
1685 @SuppressWarnings("checkstyle:linelength")
1686 static Network getNeutronNetwork(DataBroker broker, Uuid networkId) {
1687 Network network = null;
1688 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1689 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1690 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1691 Network.class, new NetworkKey(networkId));
1692 Optional<Network> net = read(broker, LogicalDatastoreType.CONFIGURATION, inst);
1693 if (net.isPresent()) {
1694 network = net.get();
1699 public static boolean isEligibleForBgp(String rd, String vpnName, BigInteger dpnId, String networkName) {
1701 if (vpnName != null && rd.equals(vpnName)) {
1704 if (dpnId != null && rd.equals(dpnId.toString())) {
1707 if (networkName != null && rd.equals(networkName)) {
1715 static String getFibFlowRef(BigInteger dpnId, short tableId, String vpnName, int priority) {
1716 return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1717 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1720 static void removeExternalTunnelDemuxFlows(String vpnName, DataBroker broker, IMdsalApiManager mdsalManager) {
1721 LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1722 for (BigInteger dpnId: NWUtil.getOperativeDPNs(broker)) {
1723 LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1724 String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1725 vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1726 FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1727 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1728 mdsalManager.removeFlow(flowEntity);
1732 public static boolean isVpnPendingDelete(DataBroker broker, String rd) {
1733 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(broker, rd);
1734 boolean isVpnPendingDelete = false;
1735 if (vpnInstanceOpData == null
1736 || vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1737 isVpnPendingDelete = true;
1739 return isVpnPendingDelete;
1742 public static List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final DataBroker broker, final String vpnName) {
1743 List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1745 final String vpnRd = getVpnRd(broker, vpnName);
1746 if (vpnRd == null) {
1747 LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1748 return vpnsToImportRoute;
1750 final VpnInstanceOpDataEntry vpnInstanceOpDataEntry = VpnUtil.getVpnInstanceOpData(broker, vpnRd);
1751 if (vpnInstanceOpDataEntry == null) {
1752 LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for {}"
1753 + " to check for vpns importing the routes", vpnName);
1754 return vpnsToImportRoute;
1757 Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1758 if (input.getVpnInstanceName() == null) {
1759 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1763 return !input.getVpnInstanceName().equals(vpnName);
1766 Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1767 Iterable<String> commonRTs =
1768 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1769 getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1770 return Iterators.size(commonRTs.iterator()) > 0;
1773 vpnsToImportRoute = getAllVpnInstanceOpData(broker)
1777 .collect(Collectors.toList());
1778 return vpnsToImportRoute;
1781 public static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1782 String name = vpnInstance.getVpnInstanceName();
1783 List<String> rts = new ArrayList<>();
1784 VpnTargets targets = vpnInstance.getVpnTargets();
1785 if (targets == null) {
1786 LOG.info("getRts: vpn targets not available for {}", name);
1789 List<VpnTarget> vpnTargets = targets.getVpnTarget();
1790 if (vpnTargets == null) {
1791 LOG.info("getRts: vpnTarget values not available for {}", name);
1794 for (VpnTarget target : vpnTargets) {
1795 //TODO: Check for RT type is Both
1796 if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1797 String rtValue = target.getVrfRTValue();
1804 public static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1805 Set<T> intersection = new HashSet<>(collection1);
1806 intersection.retainAll(collection2);
1807 return intersection;
1810 /** Get Subnetmap from its Uuid.
1811 * @param broker the data broker for look for data
1812 * @param subnetUuid the subnet's Uuid
1813 * @return the Subnetmap of Uuid or null if it is not found
1815 public static Subnetmap getSubnetmapFromItsUuid(DataBroker broker, Uuid subnetUuid) {
1816 Subnetmap sn = null;
1817 InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1818 Optional<Subnetmap> optionalSn = read(broker, LogicalDatastoreType.CONFIGURATION, id);
1819 if (optionalSn.isPresent()) {
1820 sn = optionalSn.get();
1825 public static boolean isSubnetPartOfVpn(Subnetmap sn, String vpnName) {
1826 if (vpnName == null || sn == null || sn.getVpnId() == null) {
1829 if (sn.getVpnId().getValue().equals(vpnName)) {
1831 } else if (sn.getInternetVpnId() != null
1832 && sn.getInternetVpnId().getValue().equals(vpnName)) {
1838 public static boolean isAdjacencyEligibleToVpnInternet(DataBroker dataBroker, Adjacency adjacency) {
1839 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1840 boolean adjacencyEligible = true;
1841 if (adjacency.getAdjacencyType() == AdjacencyType.ExtraRoute) {
1842 if (FibHelper.isIpv6Prefix(adjacency.getIpAddress())) {
1843 return adjacencyEligible;
1846 } else if (adjacency.getSubnetId() == null) {
1847 return adjacencyEligible;
1849 Subnetmap sn = VpnUtil.getSubnetmapFromItsUuid(
1850 dataBroker, adjacency.getSubnetId());
1851 if (sn != null && sn.getInternetVpnId() != null) {
1852 adjacencyEligible = false;
1854 return adjacencyEligible;
1857 public static boolean isAdjacencyEligibleToVpn(DataBroker dataBroker, Adjacency adjacency,
1858 String vpnName, String interfaceName) {
1859 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1860 boolean adjacencyEligible = true;
1861 // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1862 if (isBgpVpnInternet(dataBroker, vpnName)) {
1863 return isAdjacencyEligibleToVpnInternet(dataBroker, adjacency);
1865 return adjacencyEligible;
1868 public static String getInternetVpnFromVpnInstanceList(DataBroker dataBroker,
1869 List<VpnInstanceNames> vpnInstanceList) {
1870 for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1871 String vpnName = vpnInstance.getVpnName();
1872 if (isBgpVpnInternet(dataBroker, vpnName)) {
1879 /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1880 * @param dataBroker databroker for transaction
1881 * @param vpnName name of the input VPN
1882 * @return true or false
1884 public static boolean isBgpVpnInternet(DataBroker dataBroker, String vpnName) {
1885 String primaryRd = getVpnRd(dataBroker, vpnName);
1886 if (primaryRd == null) {
1887 LOG.error("isBgpVpnInternet VPN {}."
1888 + "Primary RD not found", vpnName);
1891 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1892 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1894 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1895 read(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1896 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1897 LOG.error("isBgpVpnInternet VPN {}."
1898 + "VpnInstanceOpDataEntry not found", vpnName);
1901 LOG.debug("isBgpVpnInternet VPN {}."
1902 + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1903 vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1904 if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1905 .BgpvpnType.BGPVPNInternet) {
1911 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1912 * @param ipAddress String of an representation IP address V4 or V6
1913 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1915 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1916 IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1917 int indexIpAddress = ipAddress.indexOf('/');
1918 if (indexIpAddress >= 0) {
1919 ipAddress = ipAddress.substring(0, indexIpAddress);
1922 InetAddress address = InetAddress.getByName(ipAddress);
1923 if (address instanceof Inet4Address) {
1924 return IpVersionChoice.IPV4;
1925 } else if (address instanceof Inet6Address) {
1926 return IpVersionChoice.IPV6;
1928 } catch (UnknownHostException | SecurityException e) {
1929 ipchoice = IpVersionChoice.UNDEFINED;
1934 public static void unsetScheduledToRemoveForVpnInterface(DataBroker dataBroker, String interfaceName) {
1935 VpnInterfaceBuilder builder = new VpnInterfaceBuilder().setKey(new VpnInterfaceKey(interfaceName))
1936 .setScheduledForRemove(false);
1937 MDSALDataStoreUtils.asyncUpdate(dataBroker, LogicalDatastoreType.OPERATIONAL,
1938 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(), DEFAULT_CALLBACK);