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
8 package org.opendaylight.netvirt.neutronvpn;
10 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
12 import com.google.common.base.Function;
13 import com.google.common.base.Optional;
14 import com.google.common.collect.ImmutableBiMap;
15 import com.google.common.collect.ImmutableSet;
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.net.Inet4Address;
22 import java.net.Inet6Address;
23 import java.net.InetAddress;
24 import java.net.UnknownHostException;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.Iterator;
29 import java.util.List;
32 import java.util.concurrent.ConcurrentHashMap;
33 import java.util.concurrent.ConcurrentMap;
34 import java.util.concurrent.ExecutionException;
35 import java.util.concurrent.Future;
36 import java.util.concurrent.locks.ReentrantLock;
37 import javax.inject.Inject;
38 import javax.inject.Singleton;
39 import org.apache.commons.lang3.StringUtils;
40 import org.eclipse.jdt.annotation.NonNull;
41 import org.eclipse.jdt.annotation.Nullable;
42 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
43 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
44 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
45 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
46 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
47 import org.opendaylight.genius.infra.Datastore;
48 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
49 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
50 import org.opendaylight.genius.infra.TypedWriteTransaction;
51 import org.opendaylight.genius.mdsalutil.MDSALUtil;
52 import org.opendaylight.genius.utils.JvmGlobalLocks;
53 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
54 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
55 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
56 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
57 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronConstants;
58 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
59 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
60 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
61 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAcl;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfo;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoKey;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInstances;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstanceKey;
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.opendaylight.yangtools.yang.common.Uint64;
164 import org.slf4j.Logger;
165 import org.slf4j.LoggerFactory;
168 public class NeutronvpnUtils {
170 private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
171 private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
173 new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
174 .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
175 .put(NetworkTypeGre.class, SegmentTypeGre.class)
176 .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
177 .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
180 private static final ImmutableSet<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = ImmutableSet.of(
181 NetworkTypeFlat.class,
182 NetworkTypeVlan.class,
183 NetworkTypeVxlan.class,
184 NetworkTypeGre.class);
187 private static final InstanceIdentifier<VpnInstanceOpData> VPN_INSTANCE_OP_DATA_IID =
188 InstanceIdentifier.create(VpnInstanceOpData.class);
189 private static final InstanceIdentifier<VpnMaps> VPN_MAPS_IID = InstanceIdentifier.create(VpnMaps.class);
190 private static final InstanceIdentifier<Subnetmaps> SUBNETMAPS_IID = InstanceIdentifier.create(Subnetmaps.class);
191 private static final InstanceIdentifier<Networks> NEUTRON_NETWORKS_IID = InstanceIdentifier.builder(Neutron.class)
192 .child(Networks.class).build();
193 private static final InstanceIdentifier<Ports> NEUTRON_PORTS_IID = InstanceIdentifier.builder(Neutron.class)
194 .child(Ports.class).build();
195 private static final InstanceIdentifier<Routers> NEUTRON_ROUTERS_IID = InstanceIdentifier.builder(Neutron.class)
196 .child(Routers.class).build();
197 private static final InstanceIdentifier<Subnets> NEUTRON_SUBNETS_IID = InstanceIdentifier.builder(Neutron.class)
198 .child(Subnets.class).build();
200 private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
201 private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
202 private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
203 private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
204 private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
206 private final DataBroker dataBroker;
207 private final ManagedNewTransactionRunner txRunner;
208 private final IdManagerService idManager;
209 private final JobCoordinator jobCoordinator;
210 private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
211 private static final int JOB_MAX_RETRIES = 3;
214 public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
215 final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
216 this.dataBroker = dataBroker;
217 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
218 this.idManager = idManager;
219 this.jobCoordinator = jobCoordinator;
220 this.ipV6InternetDefRt = ipV6InternetDefRt;
224 protected Subnetmap getSubnetmap(Uuid subnetId) {
225 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
226 Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
228 if (sn.isPresent()) {
231 LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
236 public VpnMap getVpnMap(Uuid id) {
237 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(id));
238 if (optionalVpnMap.isPresent()) {
239 return optionalVpnMap.get();
241 LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
246 protected Uuid getVpnForNetwork(Uuid network) {
247 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, VPN_MAPS_IID);
248 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().nonnullVpnMap() != null) {
249 for (VpnMap vpnMap : new ArrayList<>(optionalVpnMaps.get().nonnullVpnMap())) {
250 List<Uuid> netIds = vpnMap.getNetworkIds();
251 if (netIds != null && netIds.contains(network)) {
252 return vpnMap.getVpnId();
256 LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
261 protected Uuid getVpnForSubnet(Uuid subnetId) {
262 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
263 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
264 subnetmapIdentifier);
265 if (optionalSubnetMap.isPresent()) {
266 return optionalSubnetMap.get().getVpnId();
268 LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
273 protected Uuid getNetworkForSubnet(Uuid subnetId) {
274 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
275 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
276 subnetmapIdentifier);
277 if (optionalSubnetMap.isPresent()) {
278 return optionalSubnetMap.get().getNetworkId();
280 LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
284 // @param external vpn - true if external vpn being fetched, false for internal vpn
286 protected Uuid getVpnForRouter(@Nullable Uuid routerId, boolean externalVpn) {
287 if (routerId == null) {
291 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, VPN_MAPS_IID);
292 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().nonnullVpnMap() != null) {
293 for (VpnMap vpnMap : new ArrayList<>(optionalVpnMaps.get().nonnullVpnMap())) {
294 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
295 .RouterIds> routerIdsList = vpnMap.getRouterIds();
296 if (routerIdsList == null || routerIdsList.isEmpty()) {
299 // Skip router vpnId fetching from internet BGP-VPN
300 if (hasExternalNetwork(vpnMap.getNetworkIds())) {
303 // FIXME: NETVIRT-1503: this check can be replaced by a ReadOnlyTransaction.exists()
304 if (routerIdsList.stream().anyMatch(routerIds -> routerId.equals(routerIds.getRouterId()))) {
306 if (!routerId.equals(vpnMap.getVpnId())) {
307 return vpnMap.getVpnId();
310 if (routerId.equals(vpnMap.getVpnId())) {
311 return vpnMap.getVpnId();
317 LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
321 // We only need to check the first network; if it’s not an external network there’s no
322 // need to check the rest of the VPN’s network list. Note that some UUIDs may point to unknown networks, in which
323 // case we check more and assume false.
324 private boolean hasExternalNetwork(List<Uuid> uuids) {
326 for (Uuid uuid : uuids) {
327 final Network network = getNeutronNetwork(uuid);
328 if (network != null) {
329 if (Boolean.TRUE.equals(getIsExternal(network))) {
333 LOG.debug("hasExternalNetwork: cannot find network for {}", uuid);
342 protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
343 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
344 if (optionalVpnMap.isPresent()) {
345 VpnMap vpnMap = optionalVpnMap.get();
346 return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
348 LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
353 protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
354 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
355 if (optionalVpnMap.isPresent()) {
356 VpnMap vpnMap = optionalVpnMap.get();
357 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
358 return new ArrayList<>(vpnMap.getNetworkIds());
363 LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
367 protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
368 List<Uuid> subnets = new ArrayList<>();
370 Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
371 if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
372 List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
373 for (Subnetmap candidateSubnetMap : subnetMapList) {
374 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
375 subnets.add(candidateSubnetMap.getId());
383 protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
384 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
385 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
386 if (vpnPortipToPortData.isPresent()) {
387 return vpnPortipToPortData.get().getPortName();
389 LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
390 + " fixed IP {}", vpnName, fixedIp);
395 protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
396 InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
397 Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
398 if (optionalNetworkMap.isPresent()) {
399 return optionalNetworkMap.get().getSubnetIdList();
401 LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
405 protected Router getNeutronRouter(Uuid routerId) {
406 Router router = routerMap.get(routerId);
407 if (router != null) {
410 Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, getNeutronRouterIid(routerId));
411 if (rtr.isPresent()) {
417 public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
418 return NEUTRON_ROUTERS_IID.child(Router.class, new RouterKey(routerId));
421 protected @Nullable Network getNeutronNetwork(Uuid networkId) {
422 Network network = networkMap.get(networkId);
423 if (network != null) {
426 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
427 InstanceIdentifier<Network> inst = NEUTRON_NETWORKS_IID.child(Network.class, new NetworkKey(networkId));
428 return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
431 protected @Nullable Port getNeutronPort(Uuid portId) {
432 Port prt = portMap.get(portId);
436 LOG.debug("getNeutronPort for {}", portId.getValue());
437 InstanceIdentifier<Port> inst = NEUTRON_PORTS_IID.child(Port.class, new PortKey(portId));
438 return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
441 public PortIdToSubport getPortIdToSubport(Uuid portId) {
442 InstanceIdentifier<PortIdToSubport> portIdToSubportIdentifier = buildPortIdSubportMappingIdentifier(portId);
443 Optional<PortIdToSubport> optionalPortIdToSubport = read(LogicalDatastoreType.CONFIGURATION,
444 portIdToSubportIdentifier);
445 if (optionalPortIdToSubport.isPresent()) {
446 return optionalPortIdToSubport.get();
448 LOG.error("getPortIdToSubport failed, PortIdToSubport {} not present", portId.getValue());
452 protected static boolean isDhcpServerPort(Port port) {
453 return port.getDeviceOwner().equals("network:dhcp");
456 protected InterfaceAcl getDhcpInterfaceAcl(Port port) {
457 InterfaceAclBuilder interfaceAclBuilder = new InterfaceAclBuilder();
458 interfaceAclBuilder.setPortSecurityEnabled(false);
459 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.DhcpService);
460 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
461 port.getMacAddress(), port.getFixedIps());
462 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
463 return interfaceAclBuilder.build();
467 * Returns port_security_enabled status with the port.
469 * @param port the port
470 * @return port_security_enabled status
472 protected static boolean getPortSecurityEnabled(Port port) {
473 String deviceOwner = port.getDeviceOwner();
474 if (deviceOwner != null && deviceOwner.startsWith("network:")) {
475 // port with device owner of network:xxx is created by
476 // neutorn for its internal use. So security group doesn't apply.
477 // router interface, dhcp port and floating ip.
480 PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
481 if (portSecurity != null) {
482 return portSecurity.isPortSecurityEnabled();
488 * Gets security group UUIDs delta .
490 * @param port1SecurityGroups the port 1 security groups
491 * @param port2SecurityGroups the port 2 security groups
492 * @return the security groups delta
495 protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
496 @Nullable List<Uuid> port2SecurityGroups) {
497 if (port1SecurityGroups == null) {
501 if (port2SecurityGroups == null) {
502 return port1SecurityGroups;
505 List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
506 List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
507 for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
508 Uuid securityGroup1 = iterator.next();
509 for (Uuid securityGroup2 : list2) {
510 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
520 * Gets the fixed ips delta.
522 * @param port1FixedIps the port 1 fixed ips
523 * @param port2FixedIps the port 2 fixed ips
524 * @return the fixed ips delta
526 protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
527 if (port1FixedIps == null) {
531 if (port2FixedIps == null) {
532 return port1FixedIps;
535 List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
536 List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
537 for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
538 FixedIps fixedIps1 = iterator.next();
539 for (FixedIps fixedIps2 : list2) {
540 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
550 * Gets the allowed address pairs delta.
552 * @param port1AllowedAddressPairs the port 1 allowed address pairs
553 * @param port2AllowedAddressPairs the port 2 allowed address pairs
554 * @return the allowed address pairs delta
557 protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
558 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
559 .AllowedAddressPairs> port1AllowedAddressPairs,
560 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
561 .AllowedAddressPairs> port2AllowedAddressPairs) {
562 if (port1AllowedAddressPairs == null) {
566 if (port2AllowedAddressPairs == null) {
567 return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
570 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
571 .AllowedAddressPairs> list1 =
572 new ArrayList<>(port1AllowedAddressPairs);
573 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
574 .AllowedAddressPairs> list2 =
575 new ArrayList<>(port2AllowedAddressPairs);
576 for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
577 .AllowedAddressPairs> iterator =
578 list1.iterator(); iterator.hasNext();) {
579 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
580 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
581 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
582 .AllowedAddressPairs allowedAddressPair2 : list2) {
583 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
589 return getAllowedAddressPairsForAclService(list1);
593 * Gets the acl allowed address pairs.
595 * @param macAddress the mac address
596 * @param ipAddress the ip address
597 * @return the acl allowed address pairs
599 protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
600 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
601 AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
602 aclAllowedAdressPairBuilder.setMacAddress(macAddress);
603 if (ipAddress != null && ipAddress.stringValue() != null) {
604 if (ipAddress.getIpPrefix() != null) {
605 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
607 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
610 return aclAllowedAdressPairBuilder.build();
614 * Gets the allowed address pairs for acl service.
616 * @param macAddress the mac address
617 * @param fixedIps the fixed ips
618 * @return the allowed address pairs for acl service
620 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
621 List<FixedIps> fixedIps) {
622 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
623 for (FixedIps fixedIp : fixedIps) {
624 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
625 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
626 .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
628 return aclAllowedAddressPairs;
632 * Gets the allowed address pairs for acl service.
634 * @param portAllowedAddressPairs the port allowed address pairs
635 * @return the allowed address pairs for acl service
637 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
638 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
639 .AllowedAddressPairs> portAllowedAddressPairs) {
640 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
641 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
642 portAllowedAddressPair : portAllowedAddressPairs) {
643 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
644 portAllowedAddressPair.getIpAddress()));
646 return aclAllowedAddressPairs;
650 * Gets the IPv6 Link Local Address corresponding to the MAC Address.
652 * @param macAddress the mac address
653 * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
655 protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
656 IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
657 return getAclAllowedAddressPairs(macAddress,
658 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
660 ipv6LinkLocalAddress.stringValue()));
664 * Gets the updated security groups.
666 * @param aclInterfaceSecurityGroups the acl interface security groups
667 * @param origSecurityGroups the orig security groups
668 * @param newSecurityGroups the new security groups
669 * @return the updated security groups
671 protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
672 List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
673 List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
674 List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
675 List<Uuid> updatedSecurityGroups =
676 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
677 if (addedGroups != null) {
678 updatedSecurityGroups.addAll(addedGroups);
680 if (deletedGroups != null) {
681 updatedSecurityGroups.removeAll(deletedGroups);
683 return updatedSecurityGroups;
687 * Gets the allowed address pairs for fixed ips.
689 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
690 * @param portMacAddress the port mac address
691 * @param origFixedIps the orig fixed ips
692 * @param newFixedIps the new fixed ips
693 * @return the allowed address pairs for fixed ips
695 protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
696 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
697 List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
698 List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
699 List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
700 List<AllowedAddressPairs> updatedAllowedAddressPairs =
701 aclInterfaceAllowedAddressPairs != null
702 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
703 if (deletedFixedIps != null) {
704 updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
706 if (addedFixedIps != null) {
707 updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
709 return updatedAllowedAddressPairs;
713 * Gets the updated allowed address pairs.
715 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
716 * @param origAllowedAddressPairs the orig allowed address pairs
717 * @param newAllowedAddressPairs the new allowed address pairs
718 * @return the updated allowed address pairs
720 protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
721 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
722 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
723 .AllowedAddressPairs> origAllowedAddressPairs,
724 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
725 .AllowedAddressPairs> newAllowedAddressPairs) {
726 List<AllowedAddressPairs> addedAllowedAddressPairs =
727 getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
728 List<AllowedAddressPairs> deletedAllowedAddressPairs =
729 getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
730 List<AllowedAddressPairs> updatedAllowedAddressPairs =
731 aclInterfaceAllowedAddressPairs != null
732 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
733 if (addedAllowedAddressPairs != null) {
734 updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
736 if (deletedAllowedAddressPairs != null) {
737 updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
739 return updatedAllowedAddressPairs;
743 * Populate interface acl builder.
745 * @param interfaceAclBuilder the interface acl builder
746 * @param port the port
748 protected void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
749 // Handle security group enabled
750 List<Uuid> securityGroups = port.getSecurityGroups();
751 if (securityGroups != null) {
752 interfaceAclBuilder.setSecurityGroups(securityGroups);
754 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
755 port.getMacAddress(), port.getFixedIps());
756 // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
757 aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
758 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
759 portAllowedAddressPairs = port.getAllowedAddressPairs();
760 if (portAllowedAddressPairs != null) {
761 aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
763 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
764 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.AccessPort);
765 populateSubnetInfo(interfaceAclBuilder, port);
768 protected void populateSubnetInfo(InterfaceAclBuilder interfaceAclBuilder, Port port) {
769 List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
770 if (portSubnetInfo != null) {
771 interfaceAclBuilder.setSubnetInfo(portSubnetInfo);
776 protected List<SubnetInfo> getSubnetInfo(Port port) {
777 List<FixedIps> portFixedIps = port.getFixedIps();
778 if (portFixedIps == null) {
779 LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
782 List<SubnetInfo> subnetInfoList = new ArrayList<>();
783 for (FixedIps portFixedIp : portFixedIps) {
784 Uuid subnetId = portFixedIp.getSubnetId();
785 Subnet subnet = getNeutronSubnet(subnetId);
786 if (subnet != null) {
787 Class<? extends IpVersionBase> ipVersion =
788 NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
789 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
790 : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
791 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
792 .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
793 .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
794 subnetInfoList.add(subnetInfo);
797 return subnetInfoList;
800 protected Subnet getNeutronSubnet(Uuid subnetId) {
801 Subnet subnet = subnetMap.get(subnetId);
802 if (subnet != null) {
805 InstanceIdentifier<Subnet> inst = NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(subnetId));
806 Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
808 if (sn.isPresent()) {
810 addToSubnetCache(subnet);
815 protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
816 List<Subnetmap> subnetMapList = new ArrayList<>();
817 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
818 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
819 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
820 if (routerId.equals(subnetmap.getRouterId())) {
821 subnetMapList.add(subnetmap);
825 LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
826 return subnetMapList;
830 protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
831 LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
832 List<Uuid> subnetIdList = new ArrayList<>();
833 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
834 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
835 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
836 if (routerId.equals(subnetmap.getRouterId())) {
837 subnetIdList.add(subnetmap.getId());
841 LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
845 // TODO Clean up the exception handling and the console output
846 @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
848 protected Short getIPPrefixFromPort(Port port) {
850 // FIXME: why are we not using getNeutronSubnet() here? it does caching for us...
851 Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION,
852 NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(port.getFixedIps().get(0).getSubnetId())));
853 if (subnet.isPresent()) {
854 String cidr = subnet.get().getCidr().stringValue();
855 // Extract the prefix length from cidr
856 String[] parts = cidr.split("/");
857 if (parts.length == 2) {
858 return Short.valueOf(parts[1]);
860 LOG.trace("Could not retrieve prefix from subnet CIDR");
863 LOG.trace("Unable to read on subnet datastore");
865 } catch (Exception e) {
866 LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
868 LOG.error("Failed for port {}", port.getUuid().getValue());
872 // TODO Clean up the exception handling
873 @SuppressWarnings("checkstyle:IllegalCatch")
874 protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
875 boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
876 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
877 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
878 .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
879 .setVpnName(vpnName).setPortFixedip(fixedIp)
880 .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
882 if (writeConfigTxn != null) {
883 writeConfigTxn.put(id, builder.build());
885 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
887 LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
888 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
889 } catch (Exception e) {
890 LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {} for port {} with "
891 + "macAddress {}", vpnName, fixedIp, portName, macAddress, e);
895 // TODO Clean up the exception handling
896 @SuppressWarnings("checkstyle:IllegalCatch")
897 protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
898 TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
899 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
901 if (writeConfigTxn != null) {
902 writeConfigTxn.delete(id);
904 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
906 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp,
908 } catch (Exception e) {
909 LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
914 // TODO Clean up the exception handling
915 @SuppressWarnings("checkstyle:IllegalCatch")
916 protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
917 InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
918 // FIXME: can we use 'id' as the lock name?
919 final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName + fixedIp);
922 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
923 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
925 } catch (Exception e) {
926 LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
927 vpnName, fixedIp, e);
933 public void addToNetworkCache(Network network) {
934 networkMap.put(network.getUuid(), network);
937 public void removeFromNetworkCache(Network network) {
938 networkMap.remove(network.getUuid());
941 public void addToRouterCache(Router router) {
942 routerMap.put(router.getUuid(), router);
945 public void removeFromRouterCache(Router router) {
946 routerMap.remove(router.getUuid());
949 public Collection<Router> getAllRouters() {
950 return routerMap.values();
953 public void addToPortCache(Port port) {
954 portMap.put(port.getUuid(), port);
957 public void removeFromPortCache(Port port) {
958 portMap.remove(port.getUuid());
961 public void addToSubnetCache(Subnet subnet) {
962 subnetMap.put(subnet.getUuid(), subnet);
963 IpAddress gatewayIp = subnet.getGatewayIp();
964 if (gatewayIp != null) {
965 subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
969 public void removeFromSubnetCache(Subnet subnet) {
970 subnetMap.remove(subnet.getUuid());
971 IpAddress gatewayIp = subnet.getGatewayIp();
972 if (gatewayIp != null) {
973 Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
975 gwIps.remove(subnet.getUuid());
980 public static String getSegmentationIdFromNeutronNetwork(Network network) {
981 String segmentationId = null;
982 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
983 if (providerExtension != null) {
984 Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
985 segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
988 return segmentationId;
991 public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
992 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
993 return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
996 public static String getPhysicalNetworkName(Network network) {
997 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
998 return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
1001 public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
1002 return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
1005 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1006 InstanceIdentifier<VpnPortipToPort> id =
1007 InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
1008 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
1012 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
1013 InstanceIdentifier<LearntVpnVipToPort> id =
1014 InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1015 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1019 static Boolean getIsExternal(Network network) {
1020 NetworkL3Extension ext = network.augmentation(NetworkL3Extension.class);
1021 return ext != null && ext.isExternal();
1024 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1025 InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1026 NetworkMapKey(networkId)).build();
1030 static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1031 InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1032 .class, new VpnInterfaceKey(ifName)).build();
1036 static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1037 return SUBNETMAPS_IID.child(Subnetmap.class, new SubnetmapKey(subnetId));
1040 static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1041 InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1042 InterfaceKey(interfaceName)).build();
1046 static InstanceIdentifier<PortIdToSubport> buildPortIdSubportMappingIdentifier(Uuid interfaceName) {
1047 InstanceIdentifier<PortIdToSubport> id = InstanceIdentifier.builder(NeutronVpnPortIdSubportData.class)
1048 .child(PortIdToSubport.class, new PortIdToSubportKey(interfaceName)).build();
1052 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1053 .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1054 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1055 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1056 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1057 .getValue())).build();
1061 static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1062 return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1063 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1066 // TODO Remove this method entirely
1067 @SuppressWarnings("checkstyle:IllegalCatch")
1068 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1070 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1071 } catch (ReadFailedException e) {
1072 throw new RuntimeException(e);
1077 static ProviderTypes getProviderNetworkType(Network network) {
1078 if (network == null) {
1079 LOG.error("Error in getting provider network type since network is null");
1082 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1084 Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1085 if (networkTypeBase != null) {
1086 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1087 return ProviderTypes.FLAT;
1088 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1089 return ProviderTypes.VLAN;
1090 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1091 return ProviderTypes.VXLAN;
1092 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1093 return ProviderTypes.GRE;
1097 LOG.error("Error in getting provider network type since network provider extension is null for network "
1098 + "{}", network.getUuid().getValue());
1102 static boolean isNetworkTypeSupported(Network network) {
1103 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1104 return npe != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1107 static boolean isFlatOrVlanNetwork(Network network) {
1108 if (network != null) {
1109 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1111 Class<? extends NetworkTypeBase> npeType = npe.getNetworkType();
1112 if (npeType != null) {
1113 return NetworkTypeVlan.class.isAssignableFrom(npeType)
1114 || NetworkTypeFlat.class.isAssignableFrom(npeType);
1121 static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1122 return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1126 * Get inter-VPN link state.
1128 * @param vpnLinkName VPN link name
1129 * @return Optional of InterVpnLinkState
1131 public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1132 InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1133 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1134 return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1138 * Returns an InterVpnLink by searching by one of its endpoint's IP.
1140 * @param endpointIp IP to search for
1141 * @return a InterVpnLink
1143 public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1144 InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1145 Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1147 if (interVpnLinksOpData.isPresent()) {
1148 for (InterVpnLink interVpnLink : interVpnLinksOpData.get().nonnullInterVpnLink()) {
1149 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1150 || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1151 return Optional.of(interVpnLink);
1155 return Optional.absent();
1158 protected Integer releaseId(String poolName, String idKey) {
1159 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1161 Future<RpcResult<ReleaseIdOutput>> result = idManager.releaseId(idInput);
1162 if (result == null || result.get() == null || !result.get().isSuccessful()) {
1163 LOG.error("releaseId: RPC Call to release Id from pool {} with key {} returned with Errors {}",
1164 poolName, idKey, (result != null && result.get() != null) ? result.get().getErrors() :
1165 "RpcResult is null");
1167 return result.get().getResult().getIdValues().get(0).intValue();
1169 } catch (InterruptedException | ExecutionException e) {
1170 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
1172 return NeutronConstants.INVALID_ID;
1175 protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1176 byte[] octets = bytesFromHexString(mac.getValue());
1178 /* As per the RFC2373, steps involved to generate a LLA include
1179 1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1180 between OUI and NIC Specific part.
1181 2. Invert the Universal/Local flag in the OUI portion of the address.
1182 3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1183 identifier to generate the IPv6 LLA. */
1185 StringBuilder interfaceID = new StringBuilder();
1186 short u8byte = (short) (octets[0] & 0xff);
1188 interfaceID.append(Integer.toHexString(0xFF & u8byte));
1189 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1190 interfaceID.append(":");
1191 interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1192 interfaceID.append("ff:fe");
1193 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1194 interfaceID.append(":");
1195 interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1196 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1198 Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1199 IpAddress ipAddress = new IpAddress(ipv6LLA);
1203 protected static byte[] bytesFromHexString(String values) {
1205 if (values != null) {
1208 String[] octets = target.split(":");
1210 byte[] ret = new byte[octets.length];
1211 for (int i = 0; i < octets.length; i++) {
1212 ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1217 public List<String> getExistingRDs() {
1218 List<String> existingRDs = new ArrayList<>();
1219 InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1220 Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1221 if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1222 for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1223 if (vpnInstance.getIpv4Family() == null) {
1226 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1228 existingRDs.addAll(rds);
1235 protected boolean doesVpnExist(Uuid vpnId) {
1236 return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId)).isPresent();
1239 protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1240 .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1241 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1242 .rev160111.external.subnets.Subnets> subnetsIdentifier =
1243 InstanceIdentifier.builder(ExternalSubnets.class)
1244 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1245 .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1246 return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1249 public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1250 PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1251 List<FixedIps> fixedIps = port.getFixedIps();
1252 IpAddress ipAddress = null;
1253 if (isNotEmpty(fixedIps)) {
1254 ipAddress = port.getFixedIps().get(0).getIpAddress();
1256 StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1257 List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1258 if (ipAddress != null) {
1259 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1261 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1263 return staticMacEntries;
1266 public static boolean isEmpty(Collection<?> collection) {
1267 return collection == null || collection.isEmpty();
1270 public static boolean isNotEmpty(Collection<?> collection) {
1271 return !isEmpty(collection);
1275 * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1276 * @param routerUuid the Uuid for which find out the IP version associated
1277 * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1279 public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1280 IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1281 if (routerUuid == null) {
1284 List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1285 if (subnetmapList.isEmpty()) {
1288 for (Subnetmap sn : subnetmapList) {
1289 if (sn.getSubnetIp() != null) {
1290 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1291 if (rep.choice != ipVers.choice) {
1292 rep = rep.addVersion(ipVers);
1294 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1302 /**This method return the list of Subnetmap associated to the router or a empty list if any.
1303 * @param routerId the Uuid of router for which subnetmap is find out
1304 * @return a list of Subnetmap associated to the router. it could be empty if any
1306 protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1307 List<Subnetmap> subnetIdList = new ArrayList<>();
1308 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1309 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1310 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1311 if (routerId.equals(subnetmap.getRouterId())) {
1312 subnetIdList.add(subnetmap);
1316 return subnetIdList;
1319 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1320 .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1321 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1322 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1323 .instance.to.vpn.id.VpnInstance.class,
1324 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1325 .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1329 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1330 * @param vpnName Name of the VPN
1332 * @return the route-distinguisher of the VPN
1335 public String getVpnRd(String vpnName) {
1336 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1337 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1338 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1339 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1340 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1341 .VpnInstance::getVrfId).orElse(null);
1344 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1345 * @param ipAddress String of an representation IP address V4 or V6
1346 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1348 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1349 IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1350 if (ipAddress.contains("/")) {
1351 ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1354 InetAddress address = InetAddress.getByName(ipAddress);
1355 if (address instanceof Inet4Address) {
1356 return IpVersionChoice.IPV4;
1357 } else if (address instanceof Inet6Address) {
1358 return IpVersionChoice.IPV6;
1360 } catch (UnknownHostException | SecurityException e) {
1361 LOG.error("getIpVersionFromString: could not find version for {}", ipAddress);
1366 /**Get IpVersionChoice from Uuid Subnet.
1367 * @param sm Subnetmap structure
1368 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1370 public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1371 if (sm != null && sm.getSubnetIp() != null) {
1372 return getIpVersionFromString(sm.getSubnetIp());
1374 return IpVersionChoice.UNDEFINED;
1378 public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1379 String primaryRd = getVpnRd(vpnName);
1380 if (primaryRd == null) {
1381 LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1382 + "Primary RD not found", vpnName);
1385 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1386 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1387 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1388 LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1391 return vpnInstanceOpDataEntryOptional.get();
1394 protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1395 return VPN_INSTANCE_OP_DATA_IID.child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd));
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 Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1428 // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1429 List<IpVersionChoice> snIpVersions = new ArrayList<>();
1430 for (Subnetmap snMap : allSubnetMaps.get().nonnullSubnetmap()) {
1431 if (snMap.getId().equals(sm.getId())) {
1434 if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1435 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1437 if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1438 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1441 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1442 if (!snIpVersions.contains(ipVersion)) {
1448 public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1449 List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1450 int subnetCount = 0;
1451 for (Subnetmap subMap : subnetMapList) {
1452 IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1453 if (ipVersion.isIpVersionChosen(ipVer)) {
1456 if (subnetCount > 1) {
1463 public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1464 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1465 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1466 if (vpnInstanceOpDataEntry == null) {
1467 return Collections.emptyList();
1469 if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1470 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1471 + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName, ipVersion);
1472 return Collections.emptyList();
1474 if (ipVersion == IpVersionChoice.UNDEFINED) {
1475 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1476 + "is not allowed. Do nothing", vpnName);
1477 return Collections.emptyList();
1479 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder()
1480 .setVrfId(vpnInstanceOpDataEntry.getVrfId());
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 tx.merge(getVpnOpDataIdentifier(vpnInstanceOpDataEntry.getVrfId()), builder.build(), false);
1493 LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1494 add == true ? "added" : "removed", ipVersion, vpnName);
1500 * Get the vpnInstance from its Uuid.
1502 * @param broker to get informations from ds
1503 * @param vpnId the Uuid of the VPN
1504 * @return the VpnInstance or null if unfindable
1507 public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1508 if (broker == null || vpnId == null) {
1511 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1512 new VpnInstanceKey(vpnId.getValue())).build();
1513 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1514 return vpnInstance.isPresent() ? vpnInstance.get() : null;
1518 *Get the Uuid of external network of the router (remember you that one router have only one external network).
1519 * @param routerId the Uuid of the router which you try to reach the external network
1520 * @return Uuid of externalNetwork or null if is not exist
1522 protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@NonNull Uuid routerId) {
1523 LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1524 Uuid externalNetworkUuid = null;
1525 Router router = getNeutronRouter(routerId);
1526 if (router != null && router.getExternalGatewayInfo() != null) {
1527 externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1529 return externalNetworkUuid;
1532 public Uuid getInternetvpnUuidBoundToRouterId(@NonNull Uuid routerId) {
1533 Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1534 if (netId == null) {
1537 return getVpnForNetwork(netId);
1541 * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1542 * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1543 * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1544 * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1545 * @return Uuid of externalVpn or null if it is not found
1548 public Uuid getInternetvpnUuidBoundToSubnetRouter(@NonNull Uuid subnetUuid) {
1549 Subnetmap subnetmap = getSubnetmap(subnetUuid);
1550 Uuid routerUuid = subnetmap.getRouterId();
1551 LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1552 if (routerUuid == null) {
1555 Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1556 return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1560 * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1561 * @param extNet Provider Network, which has a port attached as external network gateway to router
1562 * @return a list of Private Subnetmap Ids of the router with external network gateway
1564 public @NonNull List<Uuid> getPrivateSubnetsToExport(@NonNull Network extNet, Uuid internetVpnId) {
1565 List<Uuid> subList = new ArrayList<>();
1566 List<Uuid> rtrList = new ArrayList<>();
1567 if (internetVpnId != null) {
1568 rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1570 Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1571 rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1573 if (rtrList.isEmpty()) {
1576 for (Uuid rtrId: rtrList) {
1577 Router router = getNeutronRouter(rtrId);
1578 ExternalGatewayInfo info = router.getExternalGatewayInfo();
1580 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1581 router.getUuid().getValue());
1584 // check that router really has given provider network as its external gateway port
1585 if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1586 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1587 router.getUuid().getValue(), extNet.getUuid().getValue());
1590 subList.addAll(getNeutronRouterSubnetIds(rtrId));
1595 public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1596 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1597 if (vpnInstanceOpDataEntry == null) {
1598 LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1601 Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId().toJava();
1602 List<Uuid> routerIds = new ArrayList<>();
1603 //Handle router specific V6 internet fallback flow else handle all V6 external routers
1604 if (routerId != null) {
1605 routerIds.add(routerId);
1607 //This block will execute for ext-nw to Internet VPN association/disassociation event.
1608 routerIds = getRouterIdListforVpn(vpnName);
1610 if (routerIds == null || routerIds.isEmpty()) {
1611 LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1614 for (Uuid rtrId: routerIds) {
1615 if (rtrId == null) {
1618 List<Uint64> dpnIds = getDpnsForRouter(rtrId.getValue());
1619 if (dpnIds.isEmpty()) {
1622 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1623 Long routerIdAsLong = vpnOpDataEntry.getVpnId().toJava();
1625 Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1626 if (rtrVpnId == null) {
1627 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1628 vpnId = routerIdAsLong;
1630 vpnId = getVpnId(rtrVpnId.getValue());
1632 for (Uint64 dpnId : dpnIds) {
1634 LoggingFutures.addErrorLogging(
1635 txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
1636 tx -> ipV6InternetDefRt.installDefaultRoute(tx, dpnId, rtrId.getValue(),
1637 internetBgpVpnId, vpnId)), LOG, "Error adding default route");
1639 LoggingFutures.addErrorLogging(
1640 txRunner.callWithNewReadWriteTransactionAndSubmit(Datastore.CONFIGURATION,
1641 tx -> ipV6InternetDefRt.removeDefaultRoute(tx, dpnId, rtrId.getValue(),
1642 internetBgpVpnId, vpnId)), LOG,
1643 "Error removing default route");
1649 public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @NonNull Uuid vpn) {
1650 String primaryRd = getVpnRd(vpn.getValue());
1651 if (primaryRd == null) {
1652 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1653 + "Primary RD not found", choice, vpn.getValue());
1656 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1658 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1659 read(LogicalDatastoreType.OPERATIONAL, id);
1660 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1661 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1662 + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1665 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1666 if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1667 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1668 + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1671 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1672 builder.setBgpvpnType(choice);
1673 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1674 tx.merge(id, builder.build(), false);
1675 LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1676 }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1679 public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1680 return new RouterIdsBuilder().setRouterId(routerId).build();
1683 public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1684 List<RouterIds> listRouterIds = new ArrayList<>();
1685 for (Uuid routerId : routerIds) {
1686 final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1687 listRouterIds.add(routerIdInstance);
1689 return listRouterIds;
1693 public List<Uint64> getDpnsForRouter(String routerUuid) {
1694 InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1695 .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1696 Optional<RouterDpnList> routerDpnListData =
1697 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1698 LogicalDatastoreType.OPERATIONAL, id);
1699 List<Uint64> dpns = new ArrayList<>();
1700 if (routerDpnListData.isPresent()) {
1701 for (DpnVpninterfacesList dpnVpnInterface : routerDpnListData.get().nonnullDpnVpninterfacesList()) {
1702 dpns.add(dpnVpnInterface.getDpnId());
1709 List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1710 List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1711 if (subnetIdList != null) {
1712 List<Subnetmap> subnetmapList = new ArrayList<>();
1713 for (Uuid subnetId : subnetIdList) {
1714 Subnetmap subnetmap = getSubnetmap(subnetId);
1715 if (subnetmap != null) {
1716 subnetmapList.add(subnetmap);
1718 LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1719 subnetId.getValue(), networkId.getValue());
1722 return subnetmapList;
1724 LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1725 networkId.getValue());
1730 public long getVpnId(String vpnName) {
1731 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1732 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1733 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1734 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1735 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1736 .VpnInstance::getVpnId).orElse(null).toJava();
1739 protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1740 List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1741 for (Subnetmap sm : subnetList) {
1745 IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1746 //skip further subnet processing once found first V6 subnet for the router
1747 if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1754 @SuppressWarnings({ "unchecked", "rawtypes" })
1755 public <T extends DataObject> void asyncReadAndExecute(final LogicalDatastoreType datastoreType,
1756 final InstanceIdentifier<T> iid, final String jobKey,
1757 final Function<Optional<T>, Void> function) {
1758 jobCoordinator.enqueueJob(jobKey, () -> {
1759 SettableFuture<Optional<T>> settableFuture = SettableFuture.create();
1760 List futures = Collections.singletonList(settableFuture);
1761 try (ReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction()) {
1762 Futures.addCallback(tx.read(datastoreType, iid),
1763 new SettableFutureCallback<Optional<T>>(settableFuture) {
1765 public void onSuccess(Optional<T> data) {
1766 function.apply(data);
1767 super.onSuccess(data);
1769 }, MoreExecutors.directExecutor());
1773 }, JOB_MAX_RETRIES);
1776 private static InstanceIdentifier<VpnMap> vpnMapIdentifier(Uuid uuid) {
1777 return VPN_MAPS_IID.child(VpnMap.class, new VpnMapKey(uuid));
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);