2 * Copyright (c) 2016, 2018 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.neutronvpn;
11 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
13 import com.google.common.base.Function;
14 import com.google.common.base.Optional;
15 import com.google.common.collect.ImmutableBiMap;
16 import com.google.common.collect.Sets;
17 import com.google.common.util.concurrent.FutureCallback;
18 import com.google.common.util.concurrent.Futures;
19 import com.google.common.util.concurrent.MoreExecutors;
20 import com.google.common.util.concurrent.SettableFuture;
21 import java.math.BigInteger;
22 import java.net.Inet4Address;
23 import java.net.Inet6Address;
24 import java.net.InetAddress;
25 import java.net.UnknownHostException;
26 import java.util.ArrayList;
27 import java.util.Collection;
28 import java.util.Collections;
29 import java.util.HashSet;
30 import java.util.Iterator;
31 import java.util.List;
34 import java.util.concurrent.ConcurrentHashMap;
35 import java.util.concurrent.ConcurrentMap;
36 import java.util.concurrent.ExecutionException;
37 import java.util.concurrent.locks.ReentrantLock;
38 import javax.inject.Inject;
39 import javax.inject.Singleton;
40 import org.apache.commons.lang3.StringUtils;
41 import org.eclipse.jdt.annotation.NonNull;
42 import org.eclipse.jdt.annotation.Nullable;
43 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
44 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
46 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
47 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
48 import org.opendaylight.genius.infra.Datastore;
49 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
50 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
51 import org.opendaylight.genius.infra.TypedWriteTransaction;
52 import org.opendaylight.genius.mdsalutil.MDSALUtil;
53 import org.opendaylight.genius.utils.JvmGlobalLocks;
54 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
55 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
56 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
57 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
58 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
61 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
62 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
63 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
64 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
72 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAcl;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfo;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoBuilder;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoKey;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortIdSubportData;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubport;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubportKey;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
158 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
159 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
160 import org.opendaylight.yangtools.yang.binding.DataObject;
161 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
162 import org.opendaylight.yangtools.yang.common.RpcResult;
163 import org.slf4j.Logger;
164 import org.slf4j.LoggerFactory;
167 public class NeutronvpnUtils {
169 private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
170 private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
172 new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
173 .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
174 .put(NetworkTypeGre.class, SegmentTypeGre.class)
175 .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
176 .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
179 private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
182 SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
183 SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
184 SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
185 SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
188 private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
189 private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
190 private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
191 private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
192 private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
194 private final DataBroker dataBroker;
195 private final ManagedNewTransactionRunner txRunner;
196 private final IdManagerService idManager;
197 private final JobCoordinator jobCoordinator;
198 private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
199 private static final int JOB_MAX_RETRIES = 3;
202 public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
203 final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
204 this.dataBroker = dataBroker;
205 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
206 this.idManager = idManager;
207 this.jobCoordinator = jobCoordinator;
208 this.ipV6InternetDefRt = ipV6InternetDefRt;
212 protected Subnetmap getSubnetmap(Uuid subnetId) {
213 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
214 Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
216 if (sn.isPresent()) {
219 LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
224 public VpnMap getVpnMap(Uuid id) {
225 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
226 new VpnMapKey(id)).build();
227 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
228 if (optionalVpnMap.isPresent()) {
229 return optionalVpnMap.get();
231 LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
236 protected Uuid getVpnForNetwork(Uuid network) {
237 InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
238 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
239 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
240 for (VpnMap vpnMap : optionalVpnMaps.get().nonnullVpnMap()) {
241 List<Uuid> netIds = vpnMap.getNetworkIds();
242 if (netIds != null && netIds.contains(network)) {
243 return vpnMap.getVpnId();
247 LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
252 protected Uuid getVpnForSubnet(Uuid subnetId) {
253 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
254 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
255 subnetmapIdentifier);
256 if (optionalSubnetMap.isPresent()) {
257 return optionalSubnetMap.get().getVpnId();
259 LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
264 protected Uuid getNetworkForSubnet(Uuid subnetId) {
265 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
266 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
267 subnetmapIdentifier);
268 if (optionalSubnetMap.isPresent()) {
269 return optionalSubnetMap.get().getNetworkId();
271 LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
275 // @param external vpn - true if external vpn being fetched, false for internal vpn
277 protected Uuid getVpnForRouter(@Nullable Uuid routerId, boolean externalVpn) {
278 if (routerId == null) {
282 InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
283 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
284 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
285 for (VpnMap vpnMap : optionalVpnMaps.get().nonnullVpnMap()) {
286 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
287 .RouterIds> routerIdsList = vpnMap.getRouterIds();
288 if (routerIdsList == null || routerIdsList.isEmpty()) {
291 // Skip router vpnId fetching from internet BGP-VPN
292 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
293 // We only need to check the first network; if it’s not an external network there’s no
294 // need to check the rest of the VPN’s network list
295 if (getIsExternal(getNeutronNetwork(vpnMap.getNetworkIds().iterator().next()))) {
299 // FIXME: NETVIRT-1503: this check can be replaced by a ReadOnlyTransaction.exists()
300 if (routerIdsList.stream().anyMatch(routerIds -> routerId.equals(routerIds.getRouterId()))) {
302 if (!routerId.equals(vpnMap.getVpnId())) {
303 return vpnMap.getVpnId();
306 if (routerId.equals(vpnMap.getVpnId())) {
307 return vpnMap.getVpnId();
313 LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
318 protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
319 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
320 new VpnMapKey(vpnId)).build();
321 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
322 if (optionalVpnMap.isPresent()) {
323 VpnMap vpnMap = optionalVpnMap.get();
324 return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
326 LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
331 protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
332 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
333 new VpnMapKey(vpnId)).build();
334 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
335 if (optionalVpnMap.isPresent()) {
336 VpnMap vpnMap = optionalVpnMap.get();
337 return vpnMap.getNetworkIds();
339 LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
343 protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
344 List<Uuid> subnets = new ArrayList<>();
346 InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
347 Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
348 if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
349 List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
350 for (Subnetmap candidateSubnetMap : subnetMapList) {
351 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
352 subnets.add(candidateSubnetMap.getId());
360 protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
361 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
362 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
363 if (vpnPortipToPortData.isPresent()) {
364 return vpnPortipToPortData.get().getPortName();
366 LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
367 + " fixed IP {}", vpnName, fixedIp);
372 protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
373 InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
374 Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
375 if (optionalNetworkMap.isPresent()) {
376 return optionalNetworkMap.get().getSubnetIdList();
378 LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
382 protected Router getNeutronRouter(Uuid routerId) {
383 Router router = routerMap.get(routerId);
384 if (router != null) {
387 InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
388 .class, new RouterKey(routerId));
389 Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
390 if (rtr.isPresent()) {
396 public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
397 return InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
398 .class, new RouterKey(routerId));
402 protected Network getNeutronNetwork(Uuid networkId) {
403 Network network = null;
404 network = networkMap.get(networkId);
405 if (network != null) {
408 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
409 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
410 .child(Network.class, new NetworkKey(networkId));
411 Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
412 if (net.isPresent()) {
418 protected Port getNeutronPort(Uuid portId) {
419 Port prt = portMap.get(portId);
423 LOG.debug("getNeutronPort for {}", portId.getValue());
424 InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
425 new PortKey(portId));
426 Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
427 if (port.isPresent()) {
433 public PortIdToSubport getPortIdToSubport(Uuid portId) {
434 InstanceIdentifier<PortIdToSubport> portIdToSubportIdentifier = buildPortIdSubportMappingIdentifier(portId);
435 Optional<PortIdToSubport> optionalPortIdToSubport = read(LogicalDatastoreType.CONFIGURATION,
436 portIdToSubportIdentifier);
437 if (optionalPortIdToSubport.isPresent()) {
438 return optionalPortIdToSubport.get();
440 LOG.error("getPortIdToSubport failed, PortIdToSubport {} not present", portId.getValue());
444 protected static boolean isDhcpServerPort(Port port) {
445 return port.getDeviceOwner().equals("network:dhcp");
448 protected InterfaceAcl getDhcpInterfaceAcl(Port port) {
449 InterfaceAclBuilder interfaceAclBuilder = new InterfaceAclBuilder();
450 interfaceAclBuilder.setPortSecurityEnabled(false);
451 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.DhcpService);
452 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
453 port.getMacAddress(), port.getFixedIps());
454 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
455 return interfaceAclBuilder.build();
459 * Returns port_security_enabled status with the port.
461 * @param port the port
462 * @return port_security_enabled status
464 protected static boolean getPortSecurityEnabled(Port port) {
465 String deviceOwner = port.getDeviceOwner();
466 if (deviceOwner != null && deviceOwner.startsWith("network:")) {
467 // port with device owner of network:xxx is created by
468 // neutorn for its internal use. So security group doesn't apply.
469 // router interface, dhcp port and floating ip.
472 PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
473 if (portSecurity != null) {
474 return portSecurity.isPortSecurityEnabled();
480 * Gets security group UUIDs delta .
482 * @param port1SecurityGroups the port 1 security groups
483 * @param port2SecurityGroups the port 2 security groups
484 * @return the security groups delta
487 protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
488 @Nullable List<Uuid> port2SecurityGroups) {
489 if (port1SecurityGroups == null) {
493 if (port2SecurityGroups == null) {
494 return port1SecurityGroups;
497 List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
498 List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
499 for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
500 Uuid securityGroup1 = iterator.next();
501 for (Uuid securityGroup2 : list2) {
502 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
512 * Gets the fixed ips delta.
514 * @param port1FixedIps the port 1 fixed ips
515 * @param port2FixedIps the port 2 fixed ips
516 * @return the fixed ips delta
518 protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
519 if (port1FixedIps == null) {
523 if (port2FixedIps == null) {
524 return port1FixedIps;
527 List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
528 List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
529 for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
530 FixedIps fixedIps1 = iterator.next();
531 for (FixedIps fixedIps2 : list2) {
532 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
542 * Gets the allowed address pairs delta.
544 * @param port1AllowedAddressPairs the port 1 allowed address pairs
545 * @param port2AllowedAddressPairs the port 2 allowed address pairs
546 * @return the allowed address pairs delta
549 protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
550 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
551 .AllowedAddressPairs> port1AllowedAddressPairs,
552 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
553 .AllowedAddressPairs> port2AllowedAddressPairs) {
554 if (port1AllowedAddressPairs == null) {
558 if (port2AllowedAddressPairs == null) {
559 return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
562 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
563 .AllowedAddressPairs> list1 =
564 new ArrayList<>(port1AllowedAddressPairs);
565 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
566 .AllowedAddressPairs> list2 =
567 new ArrayList<>(port2AllowedAddressPairs);
568 for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
569 .AllowedAddressPairs> iterator =
570 list1.iterator(); iterator.hasNext();) {
571 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
572 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
573 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
574 .AllowedAddressPairs allowedAddressPair2 : list2) {
575 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
581 return getAllowedAddressPairsForAclService(list1);
585 * Gets the acl allowed address pairs.
587 * @param macAddress the mac address
588 * @param ipAddress the ip address
589 * @return the acl allowed address pairs
591 protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
592 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
593 AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
594 aclAllowedAdressPairBuilder.setMacAddress(macAddress);
595 if (ipAddress != null && ipAddress.stringValue() != null) {
596 if (ipAddress.getIpPrefix() != null) {
597 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
599 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
602 return aclAllowedAdressPairBuilder.build();
606 * Gets the allowed address pairs for acl service.
608 * @param macAddress the mac address
609 * @param fixedIps the fixed ips
610 * @return the allowed address pairs for acl service
612 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
613 List<FixedIps> fixedIps) {
614 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
615 for (FixedIps fixedIp : fixedIps) {
616 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
617 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
618 .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
620 return aclAllowedAddressPairs;
624 * Gets the allowed address pairs for acl service.
626 * @param portAllowedAddressPairs the port allowed address pairs
627 * @return the allowed address pairs for acl service
629 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
630 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
631 .AllowedAddressPairs> portAllowedAddressPairs) {
632 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
633 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
634 portAllowedAddressPair : portAllowedAddressPairs) {
635 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
636 portAllowedAddressPair.getIpAddress()));
638 return aclAllowedAddressPairs;
642 * Gets the IPv6 Link Local Address corresponding to the MAC Address.
644 * @param macAddress the mac address
645 * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
647 protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
648 IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
649 return getAclAllowedAddressPairs(macAddress,
650 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
652 ipv6LinkLocalAddress.stringValue()));
656 * Gets the updated security groups.
658 * @param aclInterfaceSecurityGroups the acl interface security groups
659 * @param origSecurityGroups the orig security groups
660 * @param newSecurityGroups the new security groups
661 * @return the updated security groups
663 protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
664 List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
665 List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
666 List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
667 List<Uuid> updatedSecurityGroups =
668 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
669 if (addedGroups != null) {
670 updatedSecurityGroups.addAll(addedGroups);
672 if (deletedGroups != null) {
673 updatedSecurityGroups.removeAll(deletedGroups);
675 return updatedSecurityGroups;
679 * Gets the allowed address pairs for fixed ips.
681 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
682 * @param portMacAddress the port mac address
683 * @param origFixedIps the orig fixed ips
684 * @param newFixedIps the new fixed ips
685 * @return the allowed address pairs for fixed ips
687 protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
688 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
689 List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
690 List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
691 List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
692 List<AllowedAddressPairs> updatedAllowedAddressPairs =
693 aclInterfaceAllowedAddressPairs != null
694 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
695 if (deletedFixedIps != null) {
696 updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
698 if (addedFixedIps != null) {
699 updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
701 return updatedAllowedAddressPairs;
705 * Gets the updated allowed address pairs.
707 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
708 * @param origAllowedAddressPairs the orig allowed address pairs
709 * @param newAllowedAddressPairs the new allowed address pairs
710 * @return the updated allowed address pairs
712 protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
713 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
714 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
715 .AllowedAddressPairs> origAllowedAddressPairs,
716 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
717 .AllowedAddressPairs> newAllowedAddressPairs) {
718 List<AllowedAddressPairs> addedAllowedAddressPairs =
719 getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
720 List<AllowedAddressPairs> deletedAllowedAddressPairs =
721 getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
722 List<AllowedAddressPairs> updatedAllowedAddressPairs =
723 aclInterfaceAllowedAddressPairs != null
724 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
725 if (addedAllowedAddressPairs != null) {
726 updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
728 if (deletedAllowedAddressPairs != null) {
729 updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
731 return updatedAllowedAddressPairs;
735 * Populate interface acl builder.
737 * @param interfaceAclBuilder the interface acl builder
738 * @param port the port
740 protected void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
741 // Handle security group enabled
742 List<Uuid> securityGroups = port.getSecurityGroups();
743 if (securityGroups != null) {
744 interfaceAclBuilder.setSecurityGroups(securityGroups);
746 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
747 port.getMacAddress(), port.getFixedIps());
748 // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
749 aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
750 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
751 portAllowedAddressPairs = port.getAllowedAddressPairs();
752 if (portAllowedAddressPairs != null) {
753 aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
755 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
756 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.AccessPort);
757 populateSubnetInfo(interfaceAclBuilder, port);
760 protected void populateSubnetInfo(InterfaceAclBuilder interfaceAclBuilder, Port port) {
761 List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
762 if (portSubnetInfo != null) {
763 interfaceAclBuilder.setSubnetInfo(portSubnetInfo);
768 protected List<SubnetInfo> getSubnetInfo(Port port) {
769 List<FixedIps> portFixedIps = port.getFixedIps();
770 if (portFixedIps == null) {
771 LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
774 List<SubnetInfo> subnetInfoList = new ArrayList<>();
775 for (FixedIps portFixedIp : portFixedIps) {
776 Uuid subnetId = portFixedIp.getSubnetId();
777 Subnet subnet = getNeutronSubnet(subnetId);
778 if (subnet != null) {
779 Class<? extends IpVersionBase> ipVersion =
780 NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
781 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
782 : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
783 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
784 .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
785 .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
786 subnetInfoList.add(subnetInfo);
789 return subnetInfoList;
792 protected Subnet getNeutronSubnet(Uuid subnetId) {
793 Subnet subnet = subnetMap.get(subnetId);
794 if (subnet != null) {
797 InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
798 .class, new SubnetKey(subnetId));
799 Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
801 if (sn.isPresent()) {
803 addToSubnetCache(subnet);
808 protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
809 List<Subnetmap> subnetMapList = new ArrayList<>();
810 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
811 InstanceIdentifier.builder(Subnetmaps.class).build());
812 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
813 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
814 if (routerId.equals(subnetmap.getRouterId())) {
815 subnetMapList.add(subnetmap);
819 LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
820 return subnetMapList;
824 protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
825 LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
826 List<Uuid> subnetIdList = new ArrayList<>();
827 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
828 InstanceIdentifier.builder(Subnetmaps.class).build());
829 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
830 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
831 if (routerId.equals(subnetmap.getRouterId())) {
832 subnetIdList.add(subnetmap.getId());
836 LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
840 // TODO Clean up the exception handling and the console output
841 @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
843 protected Short getIPPrefixFromPort(Port port) {
845 Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
846 SubnetKey subnetkey = new SubnetKey(subnetUUID);
847 InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
848 .class).child(Subnet.class, subnetkey);
849 Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
850 if (subnet.isPresent()) {
851 String cidr = subnet.get().getCidr().stringValue();
852 // Extract the prefix length from cidr
853 String[] parts = cidr.split("/");
854 if (parts.length == 2) {
855 return Short.valueOf(parts[1]);
857 LOG.trace("Could not retrieve prefix from subnet CIDR");
860 LOG.trace("Unable to read on subnet datastore");
862 } catch (Exception e) {
863 LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
865 LOG.error("Failed for port {}", port.getUuid().getValue());
869 // TODO Clean up the exception handling
870 @SuppressWarnings("checkstyle:IllegalCatch")
871 protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
872 boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
873 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
874 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
875 .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
876 .setVpnName(vpnName).setPortFixedip(fixedIp)
877 .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
879 if (writeConfigTxn != null) {
880 writeConfigTxn.put(id, builder.build());
882 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
884 LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
885 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
886 } catch (Exception e) {
887 LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
892 // TODO Clean up the exception handling
893 @SuppressWarnings("checkstyle:IllegalCatch")
894 protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
895 TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
896 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
898 if (writeConfigTxn != null) {
899 writeConfigTxn.delete(id);
901 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
903 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp,
905 } catch (Exception e) {
906 LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
911 // TODO Clean up the exception handling
912 @SuppressWarnings("checkstyle:IllegalCatch")
913 protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
914 InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
915 // FIXME: can we use 'id' as the lock name?
916 final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName + fixedIp);
919 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
920 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
922 } catch (Exception e) {
923 LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
924 vpnName, fixedIp, e);
930 public void addToNetworkCache(Network network) {
931 networkMap.put(network.getUuid(), network);
934 public void removeFromNetworkCache(Network network) {
935 networkMap.remove(network.getUuid());
938 public void addToRouterCache(Router router) {
939 routerMap.put(router.getUuid(), router);
942 public void removeFromRouterCache(Router router) {
943 routerMap.remove(router.getUuid());
946 public Collection<Router> getAllRouters() {
947 return routerMap.values();
950 public void addToPortCache(Port port) {
951 portMap.put(port.getUuid(), port);
954 public void removeFromPortCache(Port port) {
955 portMap.remove(port.getUuid());
958 public void addToSubnetCache(Subnet subnet) {
959 subnetMap.put(subnet.getUuid(), subnet);
960 IpAddress gatewayIp = subnet.getGatewayIp();
961 if (gatewayIp != null) {
962 subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
966 public void removeFromSubnetCache(Subnet subnet) {
967 subnetMap.remove(subnet.getUuid());
968 IpAddress gatewayIp = subnet.getGatewayIp();
969 if (gatewayIp != null) {
970 Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
972 gwIps.remove(subnet.getUuid());
977 public static String getSegmentationIdFromNeutronNetwork(Network network) {
978 String segmentationId = null;
979 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
980 if (providerExtension != null) {
981 Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
982 segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
985 return segmentationId;
988 public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
989 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
990 return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
993 public static String getPhysicalNetworkName(Network network) {
994 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
995 return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
998 public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
999 return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
1002 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1003 InstanceIdentifier<VpnPortipToPort> id =
1004 InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
1005 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
1009 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
1010 InstanceIdentifier<LearntVpnVipToPort> id =
1011 InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1012 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1016 static Boolean getIsExternal(Network network) {
1017 return network.augmentation(NetworkL3Extension.class) != null
1018 && network.augmentation(NetworkL3Extension.class).isExternal();
1021 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1022 InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1023 NetworkMapKey(networkId)).build();
1027 static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1028 InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1029 .class, new VpnInterfaceKey(ifName)).build();
1033 static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1034 InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
1035 SubnetmapKey(subnetId)).build();
1039 static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1040 InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1041 InterfaceKey(interfaceName)).build();
1045 static InstanceIdentifier<PortIdToSubport> buildPortIdSubportMappingIdentifier(Uuid interfaceName) {
1046 InstanceIdentifier<PortIdToSubport> id = InstanceIdentifier.builder(NeutronVpnPortIdSubportData.class)
1047 .child(PortIdToSubport.class, new PortIdToSubportKey(interfaceName)).build();
1051 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1052 .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1053 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1054 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1055 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1056 .getValue())).build();
1060 static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1061 return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1062 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1065 // TODO Remove this method entirely
1066 @SuppressWarnings("checkstyle:IllegalCatch")
1067 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1069 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1070 } catch (ReadFailedException e) {
1071 throw new RuntimeException(e);
1076 static ProviderTypes getProviderNetworkType(Network network) {
1077 if (network == null) {
1078 LOG.error("Error in getting provider network type since network is null");
1081 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1083 Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1084 if (networkTypeBase != null) {
1085 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1086 return ProviderTypes.FLAT;
1087 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1088 return ProviderTypes.VLAN;
1089 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1090 return ProviderTypes.VXLAN;
1091 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1092 return ProviderTypes.GRE;
1096 LOG.error("Error in getting provider network type since network provider extension is null for network "
1097 + "{}", network.getUuid().getValue());
1101 static boolean isNetworkTypeSupported(Network network) {
1102 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1103 return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1106 static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1107 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1108 if (npe != null && npe.getNetworkType() != null) {
1109 return type.isAssignableFrom(npe.getNetworkType());
1114 static boolean isFlatOrVlanNetwork(Network network) {
1115 return network != null
1116 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1119 static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1120 return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1124 * Get inter-VPN link state.
1126 * @param vpnLinkName VPN link name
1127 * @return Optional of InterVpnLinkState
1129 public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1130 InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1131 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1132 return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1136 * Returns an InterVpnLink by searching by one of its endpoint's IP.
1138 * @param endpointIp IP to search for
1139 * @return a InterVpnLink
1141 public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1142 InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1143 Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1145 if (interVpnLinksOpData.isPresent()) {
1146 for (InterVpnLink interVpnLink : interVpnLinksOpData.get().nonnullInterVpnLink()) {
1147 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1148 || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1149 return Optional.of(interVpnLink);
1153 return Optional.absent();
1156 protected void releaseRDId(String poolName, String idKey) {
1157 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1159 RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
1160 if (!rpcResult.isSuccessful()) {
1161 LOG.error("RPC Call to Get Unique Id returned with errors for poolname {} and ID Key {}: {}",
1162 poolName, idKey, rpcResult.getErrors());
1164 LOG.info("ID {} for RD released successfully", idKey);
1166 } catch (InterruptedException | ExecutionException e) {
1167 LOG.error("Exception when trying to release ID for poolname {} and ID Key {}", poolName, idKey, e);
1171 protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1172 byte[] octets = bytesFromHexString(mac.getValue());
1174 /* As per the RFC2373, steps involved to generate a LLA include
1175 1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1176 between OUI and NIC Specific part.
1177 2. Invert the Universal/Local flag in the OUI portion of the address.
1178 3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1179 identifier to generate the IPv6 LLA. */
1181 StringBuilder interfaceID = new StringBuilder();
1182 short u8byte = (short) (octets[0] & 0xff);
1184 interfaceID.append(Integer.toHexString(0xFF & u8byte));
1185 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1186 interfaceID.append(":");
1187 interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1188 interfaceID.append("ff:fe");
1189 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1190 interfaceID.append(":");
1191 interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1192 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1194 Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1195 IpAddress ipAddress = new IpAddress(ipv6LLA);
1199 protected static byte[] bytesFromHexString(String values) {
1201 if (values != null) {
1204 String[] octets = target.split(":");
1206 byte[] ret = new byte[octets.length];
1207 for (int i = 0; i < octets.length; i++) {
1208 ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1213 public List<String> getExistingRDs() {
1214 List<String> existingRDs = new ArrayList<>();
1215 InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1216 Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1217 if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1218 for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1219 if (vpnInstance.getIpv4Family() == null) {
1222 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1224 existingRDs.addAll(rds);
1231 protected boolean doesVpnExist(Uuid vpnId) {
1232 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
1233 new VpnMapKey(vpnId)).build();
1234 return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier).isPresent();
1237 protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1238 .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1239 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1240 .rev160111.external.subnets.Subnets> subnetsIdentifier =
1241 InstanceIdentifier.builder(ExternalSubnets.class)
1242 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1243 .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1244 return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1247 public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1248 PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1249 List<FixedIps> fixedIps = port.getFixedIps();
1250 IpAddress ipAddress = null;
1251 if (isNotEmpty(fixedIps)) {
1252 ipAddress = port.getFixedIps().get(0).getIpAddress();
1254 StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1255 List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1256 if (ipAddress != null) {
1257 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1259 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1261 return staticMacEntries;
1264 public static boolean isEmpty(Collection<?> collection) {
1265 return collection == null || collection.isEmpty();
1268 public static boolean isNotEmpty(Collection<?> collection) {
1269 return !isEmpty(collection);
1273 * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1274 * @param routerUuid the Uuid for which find out the IP version associated
1275 * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1277 public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1278 IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1279 if (routerUuid == null) {
1282 List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1283 if (subnetmapList.isEmpty()) {
1286 for (Subnetmap sn : subnetmapList) {
1287 if (sn.getSubnetIp() != null) {
1288 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1289 if (rep.choice != ipVers.choice) {
1290 rep = rep.addVersion(ipVers);
1292 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1300 /**This method return the list of Subnetmap associated to the router or a empty list if any.
1301 * @param routerId the Uuid of router for which subnetmap is find out
1302 * @return a list of Subnetmap associated to the router. it could be empty if any
1304 protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1305 List<Subnetmap> subnetIdList = new ArrayList<>();
1306 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
1307 InstanceIdentifier.builder(Subnetmaps.class).build());
1308 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1309 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1310 if (routerId.equals(subnetmap.getRouterId())) {
1311 subnetIdList.add(subnetmap);
1315 return subnetIdList;
1318 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1319 .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1320 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1321 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1322 .instance.to.vpn.id.VpnInstance.class,
1323 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1324 .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1328 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1329 * @param vpnName Name of the VPN
1331 * @return the route-distinguisher of the VPN
1334 public String getVpnRd(String vpnName) {
1335 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1336 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1337 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1338 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1339 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1340 .VpnInstance::getVrfId).orElse(null);
1343 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1344 * @param ipAddress String of an representation IP address V4 or V6
1345 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1347 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1348 IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1349 if (ipAddress.contains("/")) {
1350 ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1353 InetAddress address = InetAddress.getByName(ipAddress);
1354 if (address instanceof Inet4Address) {
1355 return IpVersionChoice.IPV4;
1356 } else if (address instanceof Inet6Address) {
1357 return IpVersionChoice.IPV6;
1359 } catch (UnknownHostException | SecurityException e) {
1360 LOG.error("getIpVersionFromString: could not find version for {}", ipAddress);
1365 /**Get IpVersionChoice from Uuid Subnet.
1366 * @param sm Subnetmap structure
1367 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1369 public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1370 if (sm != null && sm.getSubnetIp() != null) {
1371 return getIpVersionFromString(sm.getSubnetIp());
1373 return IpVersionChoice.UNDEFINED;
1377 public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1378 String primaryRd = getVpnRd(vpnName);
1379 if (primaryRd == null) {
1380 LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1381 + "Primary RD not found", vpnName);
1384 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1385 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1386 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1387 LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1390 return vpnInstanceOpDataEntryOptional.get();
1393 protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1394 return InstanceIdentifier.builder(VpnInstanceOpData.class)
1395 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1398 public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1399 int subnetCount = -1;
1400 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1401 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1402 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1403 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1405 //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1408 /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1409 * for the VPN Instance.
1411 * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1412 * for the VPN Instance.
1414 if (add && subnetCount == 1) {
1416 } else if (!add && subnetCount == 0) {
1423 public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1427 InstanceIdentifier<Subnetmaps> subnetMapsId = InstanceIdentifier.builder(Subnetmaps.class).build();
1428 Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, subnetMapsId);
1429 // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1430 List<IpVersionChoice> snIpVersions = new ArrayList<>();
1431 for (Subnetmap snMap : allSubnetMaps.get().nonnullSubnetmap()) {
1432 if (snMap.getId().equals(sm.getId())) {
1435 if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1436 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1438 if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1439 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1442 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1443 if (!snIpVersions.contains(ipVersion)) {
1449 public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1450 List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1451 int subnetCount = 0;
1452 for (Subnetmap subMap : subnetMapList) {
1453 IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1454 if (ipVersion.isIpVersionChosen(ipVer)) {
1457 if (subnetCount > 1) {
1464 public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1465 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1466 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1467 if (vpnInstanceOpDataEntry == null) {
1468 return Collections.emptyList();
1470 if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1471 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1472 + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName, ipVersion);
1473 return Collections.emptyList();
1475 if (ipVersion == IpVersionChoice.UNDEFINED) {
1476 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1477 + "is not allowed. Do nothing", vpnName);
1478 return Collections.emptyList();
1480 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1481 boolean ipConfigured = add;
1482 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4AND6)) {
1483 builder.setIpv4Configured(ipConfigured);
1484 builder.setIpv6Configured(ipConfigured);
1485 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1486 builder.setIpv4Configured(ipConfigured);
1487 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1488 builder.setIpv6Configured(ipConfigured);
1490 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1491 OPERATIONAL, tx -> {
1492 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
1493 .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
1494 new VpnInstanceOpDataEntryKey(vpnInstanceOpDataEntry.getVrfId())).build();
1495 tx.merge(id, builder.build(), false);
1496 LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1497 add == true ? "added" : "removed", ipVersion, vpnName);
1503 * Get the vpnInstance from its Uuid.
1505 * @param broker to get informations from ds
1506 * @param vpnId the Uuid of the VPN
1507 * @return the VpnInstance or null if unfindable
1510 public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1511 if (broker == null || vpnId == null) {
1514 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1515 new VpnInstanceKey(vpnId.getValue())).build();
1516 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1517 return vpnInstance.isPresent() ? vpnInstance.get() : null;
1521 *Get the Uuid of external network of the router (remember you that one router have only one external network).
1522 * @param routerId the Uuid of the router which you try to reach the external network
1523 * @return Uuid of externalNetwork or null if is not exist
1525 protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@NonNull Uuid routerId) {
1526 LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1527 Uuid externalNetworkUuid = null;
1528 Router router = getNeutronRouter(routerId);
1529 if (router != null && router.getExternalGatewayInfo() != null) {
1530 externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1532 return externalNetworkUuid;
1535 public Uuid getInternetvpnUuidBoundToRouterId(@NonNull Uuid routerId) {
1536 Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1537 if (netId == null) {
1540 return getVpnForNetwork(netId);
1544 * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1545 * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1546 * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1547 * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1548 * @return Uuid of externalVpn or null if it is not found
1551 public Uuid getInternetvpnUuidBoundToSubnetRouter(@NonNull Uuid subnetUuid) {
1552 Subnetmap subnetmap = getSubnetmap(subnetUuid);
1553 Uuid routerUuid = subnetmap.getRouterId();
1554 LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1555 if (routerUuid == null) {
1558 Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1559 return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1563 * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1564 * @param extNet Provider Network, which has a port attached as external network gateway to router
1565 * @return a list of Private Subnetmap Ids of the router with external network gateway
1567 public @NonNull List<Uuid> getPrivateSubnetsToExport(@NonNull Network extNet, Uuid internetVpnId) {
1568 List<Uuid> subList = new ArrayList<>();
1569 List<Uuid> rtrList = new ArrayList<>();
1570 if (internetVpnId != null) {
1571 rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1573 Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1574 rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1576 if (rtrList.isEmpty()) {
1579 for (Uuid rtrId: rtrList) {
1580 Router router = getNeutronRouter(rtrId);
1581 ExternalGatewayInfo info = router.getExternalGatewayInfo();
1583 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1584 router.getUuid().getValue());
1587 // check that router really has given provider network as its external gateway port
1588 if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1589 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1590 router.getUuid().getValue(), extNet.getUuid().getValue());
1593 subList.addAll(getNeutronRouterSubnetIds(rtrId));
1598 public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1599 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1600 if (vpnInstanceOpDataEntry == null) {
1601 LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1604 Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId();
1605 List<Uuid> routerIds = new ArrayList<>();
1606 //Handle router specific V6 internet fallback flow else handle all V6 external routers
1607 if (routerId != null) {
1608 routerIds.add(routerId);
1610 //This block will execute for ext-nw to Internet VPN association/disassociation event.
1611 routerIds = getRouterIdListforVpn(vpnName);
1613 if (routerIds == null || routerIds.isEmpty()) {
1614 LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1617 for (Uuid rtrId: routerIds) {
1618 if (rtrId == null) {
1621 List<BigInteger> dpnIds = getDpnsForRouter(rtrId.getValue());
1622 if (dpnIds.isEmpty()) {
1625 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1626 Long routerIdAsLong = vpnOpDataEntry.getVpnId();
1628 Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1629 if (rtrVpnId == null) {
1630 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1631 vpnId = routerIdAsLong;
1633 vpnId = getVpnId(rtrVpnId.getValue());
1635 for (BigInteger dpnId : dpnIds) {
1637 LoggingFutures.addErrorLogging(
1638 txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
1639 tx -> ipV6InternetDefRt.installDefaultRoute(tx, dpnId, rtrId.getValue(), internetBgpVpnId,
1640 vpnId)), LOG, "Error adding default route");
1642 LoggingFutures.addErrorLogging(
1643 txRunner.callWithNewReadWriteTransactionAndSubmit(Datastore.CONFIGURATION,
1644 tx -> ipV6InternetDefRt.removeDefaultRoute(tx, dpnId, rtrId.getValue(), internetBgpVpnId,
1646 "Error removing default route");
1652 public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @NonNull Uuid vpn) {
1653 String primaryRd = getVpnRd(vpn.getValue());
1654 if (primaryRd == null) {
1655 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1656 + "Primary RD not found", choice, vpn.getValue());
1659 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1660 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1662 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1663 read(LogicalDatastoreType.OPERATIONAL, id);
1664 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1665 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1666 + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1669 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1670 if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1671 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1672 + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1675 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1676 builder.setBgpvpnType(choice);
1677 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1678 tx.merge(id, builder.build(), false);
1679 LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1680 }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1683 public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1684 return new RouterIdsBuilder().setRouterId(routerId).build();
1687 public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1688 List<RouterIds> listRouterIds = new ArrayList<>();
1689 for (Uuid routerId : routerIds) {
1690 final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1691 listRouterIds.add(routerIdInstance);
1693 return listRouterIds;
1697 public List<BigInteger> getDpnsForRouter(String routerUuid) {
1698 InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1699 .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1700 Optional<RouterDpnList> routerDpnListData =
1701 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1702 LogicalDatastoreType.OPERATIONAL, id);
1703 List<BigInteger> dpns = new ArrayList<>();
1704 if (routerDpnListData.isPresent()) {
1705 for (DpnVpninterfacesList dpnVpnInterface : routerDpnListData.get().nonnullDpnVpninterfacesList()) {
1706 dpns.add(dpnVpnInterface.getDpnId());
1713 List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1714 List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1715 if (subnetIdList != null) {
1716 List<Subnetmap> subnetmapList = new ArrayList<>();
1717 for (Uuid subnetId : subnetIdList) {
1718 Subnetmap subnetmap = getSubnetmap(subnetId);
1719 if (subnetmap != null) {
1720 subnetmapList.add(subnetmap);
1722 LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1723 subnetId.getValue(), networkId.getValue());
1726 return subnetmapList;
1728 LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1729 networkId.getValue());
1734 public long getVpnId(String vpnName) {
1735 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1736 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1737 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1738 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1739 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1740 .VpnInstance::getVpnId).orElse(null);
1743 protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1744 List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1745 for (Subnetmap sm : subnetList) {
1749 IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1750 //skip further subnet processing once found first V6 subnet for the router
1751 if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1758 @SuppressWarnings({ "unchecked", "rawtypes" })
1759 public <T extends DataObject> void asyncReadAndExecute(final LogicalDatastoreType datastoreType,
1760 final InstanceIdentifier<T> iid, final String jobKey,
1761 final Function<Optional<T>, Void> function) {
1762 jobCoordinator.enqueueJob(jobKey, () -> {
1763 SettableFuture<Optional<T>> settableFuture = SettableFuture.create();
1764 List futures = Collections.singletonList(settableFuture);
1765 try (ReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction()) {
1766 Futures.addCallback(tx.read(datastoreType, iid),
1767 new SettableFutureCallback<Optional<T>>(settableFuture) {
1769 public void onSuccess(Optional<T> data) {
1770 function.apply(data);
1771 super.onSuccess(data);
1773 }, MoreExecutors.directExecutor());
1777 }, JOB_MAX_RETRIES);
1780 private class SettableFutureCallback<T> implements FutureCallback<T> {
1782 private final SettableFuture<T> settableFuture;
1784 SettableFutureCallback(SettableFuture<T> settableFuture) {
1785 this.settableFuture = settableFuture;
1789 public void onSuccess(T objT) {
1790 settableFuture.set(objT);
1794 public void onFailure(Throwable throwable) {
1795 settableFuture.setException(throwable);