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.CONFIGURATION;
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.ImmutableSet;
17 import com.google.common.collect.Sets;
18 import com.google.common.util.concurrent.FutureCallback;
19 import com.google.common.util.concurrent.Futures;
20 import com.google.common.util.concurrent.MoreExecutors;
21 import com.google.common.util.concurrent.SettableFuture;
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.Iterator;
30 import java.util.List;
33 import java.util.concurrent.ConcurrentHashMap;
34 import java.util.concurrent.ConcurrentMap;
35 import java.util.concurrent.ExecutionException;
36 import java.util.concurrent.Future;
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.NeutronConstants;
59 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAcl;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfo;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoKey;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInstances;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInterfaces;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstanceBuilder;
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.l3vpn.rev200204.vpn.interfaces.VpnInterface;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterfaceKey;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortIdSubportData;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubport;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.port.id.subport.data.PortIdToSubportKey;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
158 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
159 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
160 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
161 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
162 import org.opendaylight.yangtools.yang.binding.DataObject;
163 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
164 import org.opendaylight.yangtools.yang.common.RpcResult;
165 import org.opendaylight.yangtools.yang.common.Uint64;
166 import org.slf4j.Logger;
167 import org.slf4j.LoggerFactory;
170 public class NeutronvpnUtils {
172 private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
173 private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
175 new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
176 .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
177 .put(NetworkTypeGre.class, SegmentTypeGre.class)
178 .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
179 .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
182 private static final ImmutableSet<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = ImmutableSet.of(
183 NetworkTypeFlat.class,
184 NetworkTypeVlan.class,
185 NetworkTypeVxlan.class,
186 NetworkTypeGre.class);
189 private static final InstanceIdentifier<VpnInstanceOpData> VPN_INSTANCE_OP_DATA_IID =
190 InstanceIdentifier.create(VpnInstanceOpData.class);
191 private static final InstanceIdentifier<VpnMaps> VPN_MAPS_IID = InstanceIdentifier.create(VpnMaps.class);
192 private static final InstanceIdentifier<Subnetmaps> SUBNETMAPS_IID = InstanceIdentifier.create(Subnetmaps.class);
193 private static final InstanceIdentifier<Networks> NEUTRON_NETWORKS_IID = InstanceIdentifier.builder(Neutron.class)
194 .child(Networks.class).build();
195 private static final InstanceIdentifier<Ports> NEUTRON_PORTS_IID = InstanceIdentifier.builder(Neutron.class)
196 .child(Ports.class).build();
197 private static final InstanceIdentifier<Routers> NEUTRON_ROUTERS_IID = InstanceIdentifier.builder(Neutron.class)
198 .child(Routers.class).build();
199 private static final InstanceIdentifier<Subnets> NEUTRON_SUBNETS_IID = InstanceIdentifier.builder(Neutron.class)
200 .child(Subnets.class).build();
202 private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
203 private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
204 private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
205 private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
206 private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
208 private final DataBroker dataBroker;
209 private final ManagedNewTransactionRunner txRunner;
210 private final IdManagerService idManager;
211 private final JobCoordinator jobCoordinator;
212 private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
213 private static final int JOB_MAX_RETRIES = 3;
216 public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
217 final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
218 this.dataBroker = dataBroker;
219 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
220 this.idManager = idManager;
221 this.jobCoordinator = jobCoordinator;
222 this.ipV6InternetDefRt = ipV6InternetDefRt;
226 protected Subnetmap getSubnetmap(Uuid subnetId) {
227 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
228 Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
230 if (sn.isPresent()) {
233 LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
238 public VpnMap getVpnMap(Uuid id) {
239 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(id));
240 if (optionalVpnMap.isPresent()) {
241 return optionalVpnMap.get();
243 LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
248 protected Uuid getVpnForNetwork(Uuid network) {
249 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, VPN_MAPS_IID);
250 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().nonnullVpnMap() != null) {
251 for (VpnMap vpnMap : new ArrayList<>(optionalVpnMaps.get().nonnullVpnMap())) {
252 List<Uuid> netIds = vpnMap.getNetworkIds();
253 if (netIds != null && netIds.contains(network)) {
254 return vpnMap.getVpnId();
258 LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
263 protected Uuid getVpnForSubnet(Uuid subnetId) {
264 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
265 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
266 subnetmapIdentifier);
267 if (optionalSubnetMap.isPresent()) {
268 return optionalSubnetMap.get().getVpnId();
270 LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
275 protected Uuid getNetworkForSubnet(Uuid subnetId) {
276 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
277 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
278 subnetmapIdentifier);
279 if (optionalSubnetMap.isPresent()) {
280 return optionalSubnetMap.get().getNetworkId();
282 LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
286 // @param external vpn - true if external vpn being fetched, false for internal vpn
288 protected Uuid getVpnForRouter(@Nullable Uuid routerId, boolean externalVpn) {
289 if (routerId == null) {
293 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, VPN_MAPS_IID);
294 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().nonnullVpnMap() != null) {
295 for (VpnMap vpnMap : new ArrayList<>(optionalVpnMaps.get().nonnullVpnMap())) {
296 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
297 .RouterIds> routerIdsList = vpnMap.getRouterIds();
298 if (routerIdsList == null || routerIdsList.isEmpty()) {
301 // Skip router vpnId fetching from internet BGP-VPN
302 if (hasExternalNetwork(vpnMap.getNetworkIds())) {
305 // FIXME: NETVIRT-1503: this check can be replaced by a ReadOnlyTransaction.exists()
306 if (routerIdsList.stream().anyMatch(routerIds -> routerId.equals(routerIds.getRouterId()))) {
308 if (!routerId.equals(vpnMap.getVpnId())) {
309 return vpnMap.getVpnId();
312 if (routerId.equals(vpnMap.getVpnId())) {
313 return vpnMap.getVpnId();
319 LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
323 // We only need to check the first network; if it’s not an external network there’s no
324 // need to check the rest of the VPN’s network list. Note that some UUIDs may point to unknown networks, in which
325 // case we check more and assume false.
326 private boolean hasExternalNetwork(List<Uuid> uuids) {
328 for (Uuid uuid : uuids) {
329 final Network network = getNeutronNetwork(uuid);
330 if (network != null) {
331 if (Boolean.TRUE.equals(getIsExternal(network))) {
335 LOG.debug("hasExternalNetwork: cannot find network for {}", uuid);
344 protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
345 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
346 if (optionalVpnMap.isPresent()) {
347 VpnMap vpnMap = optionalVpnMap.get();
348 return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
350 LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
355 protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
356 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
357 if (optionalVpnMap.isPresent()) {
358 VpnMap vpnMap = optionalVpnMap.get();
359 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
360 return new ArrayList<>(vpnMap.getNetworkIds());
365 LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
369 protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
370 List<Uuid> subnets = new ArrayList<>();
372 Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
373 if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
374 List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
375 for (Subnetmap candidateSubnetMap : subnetMapList) {
376 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
377 subnets.add(candidateSubnetMap.getId());
385 protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
386 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
387 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
388 if (vpnPortipToPortData.isPresent()) {
389 return vpnPortipToPortData.get().getPortName();
391 LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
392 + " fixed IP {}", vpnName, fixedIp);
397 protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
398 InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
399 Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
400 if (optionalNetworkMap.isPresent()) {
401 return optionalNetworkMap.get().getSubnetIdList();
403 LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
407 protected Router getNeutronRouter(Uuid routerId) {
408 Router router = routerMap.get(routerId);
409 if (router != null) {
412 Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, getNeutronRouterIid(routerId));
413 if (rtr.isPresent()) {
419 public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
420 return NEUTRON_ROUTERS_IID.child(Router.class, new RouterKey(routerId));
423 protected @Nullable Network getNeutronNetwork(Uuid networkId) {
424 Network network = networkMap.get(networkId);
425 if (network != null) {
428 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
429 InstanceIdentifier<Network> inst = NEUTRON_NETWORKS_IID.child(Network.class, new NetworkKey(networkId));
430 return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
433 protected @Nullable Port getNeutronPort(Uuid portId) {
434 Port prt = portMap.get(portId);
438 LOG.debug("getNeutronPort for {}", portId.getValue());
439 InstanceIdentifier<Port> inst = NEUTRON_PORTS_IID.child(Port.class, new PortKey(portId));
440 return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
443 public PortIdToSubport getPortIdToSubport(Uuid portId) {
444 InstanceIdentifier<PortIdToSubport> portIdToSubportIdentifier = buildPortIdSubportMappingIdentifier(portId);
445 Optional<PortIdToSubport> optionalPortIdToSubport = read(LogicalDatastoreType.CONFIGURATION,
446 portIdToSubportIdentifier);
447 if (optionalPortIdToSubport.isPresent()) {
448 return optionalPortIdToSubport.get();
450 LOG.error("getPortIdToSubport failed, PortIdToSubport {} not present", portId.getValue());
454 protected static boolean isDhcpServerPort(Port port) {
455 return port.getDeviceOwner().equals("network:dhcp");
458 protected InterfaceAcl getDhcpInterfaceAcl(Port port) {
459 InterfaceAclBuilder interfaceAclBuilder = new InterfaceAclBuilder();
460 interfaceAclBuilder.setPortSecurityEnabled(false);
461 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.DhcpService);
462 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
463 port.getMacAddress(), port.getFixedIps());
464 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
465 return interfaceAclBuilder.build();
469 * Returns port_security_enabled status with the port.
471 * @param port the port
472 * @return port_security_enabled status
474 protected static boolean getPortSecurityEnabled(Port port) {
475 String deviceOwner = port.getDeviceOwner();
476 if (deviceOwner != null && deviceOwner.startsWith("network:")) {
477 // port with device owner of network:xxx is created by
478 // neutorn for its internal use. So security group doesn't apply.
479 // router interface, dhcp port and floating ip.
482 PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
483 if (portSecurity != null) {
484 return portSecurity.isPortSecurityEnabled();
490 * Gets security group UUIDs delta .
492 * @param port1SecurityGroups the port 1 security groups
493 * @param port2SecurityGroups the port 2 security groups
494 * @return the security groups delta
497 protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
498 @Nullable List<Uuid> port2SecurityGroups) {
499 if (port1SecurityGroups == null) {
503 if (port2SecurityGroups == null) {
504 return port1SecurityGroups;
507 List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
508 List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
509 for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
510 Uuid securityGroup1 = iterator.next();
511 for (Uuid securityGroup2 : list2) {
512 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
522 * Gets the fixed ips delta.
524 * @param port1FixedIps the port 1 fixed ips
525 * @param port2FixedIps the port 2 fixed ips
526 * @return the fixed ips delta
528 protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
529 if (port1FixedIps == null) {
533 if (port2FixedIps == null) {
534 return port1FixedIps;
537 List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
538 List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
539 for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
540 FixedIps fixedIps1 = iterator.next();
541 for (FixedIps fixedIps2 : list2) {
542 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
552 * Gets the allowed address pairs delta.
554 * @param port1AllowedAddressPairs the port 1 allowed address pairs
555 * @param port2AllowedAddressPairs the port 2 allowed address pairs
556 * @return the allowed address pairs delta
559 protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
560 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
561 .AllowedAddressPairs> port1AllowedAddressPairs,
562 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
563 .AllowedAddressPairs> port2AllowedAddressPairs) {
564 if (port1AllowedAddressPairs == null) {
568 if (port2AllowedAddressPairs == null) {
569 return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
572 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
573 .AllowedAddressPairs> list1 =
574 new ArrayList<>(port1AllowedAddressPairs);
575 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
576 .AllowedAddressPairs> list2 =
577 new ArrayList<>(port2AllowedAddressPairs);
578 for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
579 .AllowedAddressPairs> iterator =
580 list1.iterator(); iterator.hasNext();) {
581 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
582 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
583 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
584 .AllowedAddressPairs allowedAddressPair2 : list2) {
585 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
591 return getAllowedAddressPairsForAclService(list1);
595 * Gets the acl allowed address pairs.
597 * @param macAddress the mac address
598 * @param ipAddress the ip address
599 * @return the acl allowed address pairs
601 protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
602 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
603 AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
604 aclAllowedAdressPairBuilder.setMacAddress(macAddress);
605 if (ipAddress != null && ipAddress.stringValue() != null) {
606 if (ipAddress.getIpPrefix() != null) {
607 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
609 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
612 return aclAllowedAdressPairBuilder.build();
616 * Gets the allowed address pairs for acl service.
618 * @param macAddress the mac address
619 * @param fixedIps the fixed ips
620 * @return the allowed address pairs for acl service
622 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
623 List<FixedIps> fixedIps) {
624 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
625 for (FixedIps fixedIp : fixedIps) {
626 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
627 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
628 .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
630 return aclAllowedAddressPairs;
634 * Gets the allowed address pairs for acl service.
636 * @param portAllowedAddressPairs the port allowed address pairs
637 * @return the allowed address pairs for acl service
639 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
640 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
641 .AllowedAddressPairs> portAllowedAddressPairs) {
642 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
643 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
644 portAllowedAddressPair : portAllowedAddressPairs) {
645 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
646 portAllowedAddressPair.getIpAddress()));
648 return aclAllowedAddressPairs;
652 * Gets the IPv6 Link Local Address corresponding to the MAC Address.
654 * @param macAddress the mac address
655 * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
657 protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
658 IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
659 return getAclAllowedAddressPairs(macAddress,
660 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
662 ipv6LinkLocalAddress.stringValue()));
666 * Gets the updated security groups.
668 * @param aclInterfaceSecurityGroups the acl interface security groups
669 * @param origSecurityGroups the orig security groups
670 * @param newSecurityGroups the new security groups
671 * @return the updated security groups
673 protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
674 List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
675 List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
676 List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
677 List<Uuid> updatedSecurityGroups =
678 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
679 if (addedGroups != null) {
680 updatedSecurityGroups.addAll(addedGroups);
682 if (deletedGroups != null) {
683 updatedSecurityGroups.removeAll(deletedGroups);
685 return updatedSecurityGroups;
689 * Gets the allowed address pairs for fixed ips.
691 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
692 * @param portMacAddress the port mac address
693 * @param origFixedIps the orig fixed ips
694 * @param newFixedIps the new fixed ips
695 * @return the allowed address pairs for fixed ips
697 protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
698 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
699 List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
700 List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
701 List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
702 List<AllowedAddressPairs> updatedAllowedAddressPairs =
703 aclInterfaceAllowedAddressPairs != null
704 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
705 if (deletedFixedIps != null) {
706 updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
708 if (addedFixedIps != null) {
709 updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
711 return updatedAllowedAddressPairs;
715 * Gets the updated allowed address pairs.
717 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
718 * @param origAllowedAddressPairs the orig allowed address pairs
719 * @param newAllowedAddressPairs the new allowed address pairs
720 * @return the updated allowed address pairs
722 protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
723 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
724 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
725 .AllowedAddressPairs> origAllowedAddressPairs,
726 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
727 .AllowedAddressPairs> newAllowedAddressPairs) {
728 List<AllowedAddressPairs> addedAllowedAddressPairs =
729 getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
730 List<AllowedAddressPairs> deletedAllowedAddressPairs =
731 getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
732 List<AllowedAddressPairs> updatedAllowedAddressPairs =
733 aclInterfaceAllowedAddressPairs != null
734 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
735 if (addedAllowedAddressPairs != null) {
736 updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
738 if (deletedAllowedAddressPairs != null) {
739 updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
741 return updatedAllowedAddressPairs;
745 * Populate interface acl builder.
747 * @param interfaceAclBuilder the interface acl builder
748 * @param port the port
750 protected void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
751 // Handle security group enabled
752 List<Uuid> securityGroups = port.getSecurityGroups();
753 if (securityGroups != null) {
754 interfaceAclBuilder.setSecurityGroups(securityGroups);
756 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
757 port.getMacAddress(), port.getFixedIps());
758 // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
759 aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
760 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
761 portAllowedAddressPairs = port.getAllowedAddressPairs();
762 if (portAllowedAddressPairs != null) {
763 aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
765 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
766 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.AccessPort);
767 populateSubnetInfo(interfaceAclBuilder, port);
770 protected void populateSubnetInfo(InterfaceAclBuilder interfaceAclBuilder, Port port) {
771 List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
772 if (portSubnetInfo != null) {
773 interfaceAclBuilder.setSubnetInfo(portSubnetInfo);
778 protected List<SubnetInfo> getSubnetInfo(Port port) {
779 List<FixedIps> portFixedIps = port.getFixedIps();
780 if (portFixedIps == null) {
781 LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
784 List<SubnetInfo> subnetInfoList = new ArrayList<>();
785 for (FixedIps portFixedIp : portFixedIps) {
786 Uuid subnetId = portFixedIp.getSubnetId();
787 Subnet subnet = getNeutronSubnet(subnetId);
788 if (subnet != null) {
789 Class<? extends IpVersionBase> ipVersion =
790 NeutronSecurityGroupConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
791 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
792 : NeutronSecurityGroupConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
793 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
794 .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
795 .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
796 subnetInfoList.add(subnetInfo);
799 return subnetInfoList;
802 protected Subnet getNeutronSubnet(Uuid subnetId) {
803 Subnet subnet = subnetMap.get(subnetId);
804 if (subnet != null) {
807 InstanceIdentifier<Subnet> inst = NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(subnetId));
808 Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
810 if (sn.isPresent()) {
812 addToSubnetCache(subnet);
817 protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
818 List<Subnetmap> subnetMapList = new ArrayList<>();
819 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
820 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
821 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
822 if (routerId.equals(subnetmap.getRouterId())) {
823 subnetMapList.add(subnetmap);
827 LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
828 return subnetMapList;
832 protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
833 LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
834 List<Uuid> subnetIdList = new ArrayList<>();
835 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
836 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
837 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
838 if (routerId.equals(subnetmap.getRouterId())) {
839 subnetIdList.add(subnetmap.getId());
843 LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
847 // TODO Clean up the exception handling and the console output
848 @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
850 protected Short getIPPrefixFromPort(Port port) {
852 // FIXME: why are we not using getNeutronSubnet() here? it does caching for us...
853 Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION,
854 NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(port.getFixedIps().get(0).getSubnetId())));
855 if (subnet.isPresent()) {
856 String cidr = subnet.get().getCidr().stringValue();
857 // Extract the prefix length from cidr
858 String[] parts = cidr.split("/");
859 if (parts.length == 2) {
860 return Short.valueOf(parts[1]);
862 LOG.trace("Could not retrieve prefix from subnet CIDR");
865 LOG.trace("Unable to read on subnet datastore");
867 } catch (Exception e) {
868 LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
870 LOG.error("Failed for port {}", port.getUuid().getValue());
874 // TODO Clean up the exception handling
875 @SuppressWarnings("checkstyle:IllegalCatch")
876 protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
877 boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
878 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
879 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
880 .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
881 .setVpnName(vpnName).setPortFixedip(fixedIp)
882 .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
884 if (writeConfigTxn != null) {
885 writeConfigTxn.put(id, builder.build());
887 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
889 LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
890 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
891 } catch (Exception e) {
892 LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {} for port {} with "
893 + "macAddress {}", vpnName, fixedIp, portName, macAddress, e);
897 // TODO Clean up the exception handling
898 @SuppressWarnings("checkstyle:IllegalCatch")
899 protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
900 TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
901 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
903 if (writeConfigTxn != null) {
904 writeConfigTxn.delete(id);
906 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
908 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp,
910 } catch (Exception e) {
911 LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
916 // TODO Clean up the exception handling
917 @SuppressWarnings("checkstyle:IllegalCatch")
918 protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
919 InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
920 // FIXME: can we use 'id' as the lock name?
921 final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName + fixedIp);
924 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
925 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
927 } catch (Exception e) {
928 LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
929 vpnName, fixedIp, e);
935 public void addToNetworkCache(Network network) {
936 networkMap.put(network.getUuid(), network);
939 public void removeFromNetworkCache(Network network) {
940 networkMap.remove(network.getUuid());
943 public void addToRouterCache(Router router) {
944 routerMap.put(router.getUuid(), router);
947 public void removeFromRouterCache(Router router) {
948 routerMap.remove(router.getUuid());
951 public Collection<Router> getAllRouters() {
952 return routerMap.values();
955 public void addToPortCache(Port port) {
956 portMap.put(port.getUuid(), port);
959 public void removeFromPortCache(Port port) {
960 portMap.remove(port.getUuid());
963 public void addToSubnetCache(Subnet subnet) {
964 subnetMap.put(subnet.getUuid(), subnet);
965 IpAddress gatewayIp = subnet.getGatewayIp();
966 if (gatewayIp != null) {
967 subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
971 public void removeFromSubnetCache(Subnet subnet) {
972 subnetMap.remove(subnet.getUuid());
973 IpAddress gatewayIp = subnet.getGatewayIp();
974 if (gatewayIp != null) {
975 Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
977 gwIps.remove(subnet.getUuid());
982 public static String getSegmentationIdFromNeutronNetwork(Network network) {
983 String segmentationId = null;
984 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
985 if (providerExtension != null) {
986 Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
987 segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
990 return segmentationId;
993 public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
994 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
995 return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
998 public static String getPhysicalNetworkName(Network network) {
999 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
1000 return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
1003 public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
1004 return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
1007 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1008 InstanceIdentifier<VpnPortipToPort> id =
1009 InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
1010 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
1014 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
1015 InstanceIdentifier<LearntVpnVipToPort> id =
1016 InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1017 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1021 static Boolean getIsExternal(Network network) {
1022 NetworkL3Extension ext = network.augmentation(NetworkL3Extension.class);
1023 return ext != null && ext.isExternal();
1026 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1027 InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1028 NetworkMapKey(networkId)).build();
1032 static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1033 InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1034 .class, new VpnInterfaceKey(ifName)).build();
1038 static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1039 return SUBNETMAPS_IID.child(Subnetmap.class, new SubnetmapKey(subnetId));
1042 static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1043 InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1044 InterfaceKey(interfaceName)).build();
1048 static InstanceIdentifier<PortIdToSubport> buildPortIdSubportMappingIdentifier(Uuid interfaceName) {
1049 InstanceIdentifier<PortIdToSubport> id = InstanceIdentifier.builder(NeutronVpnPortIdSubportData.class)
1050 .child(PortIdToSubport.class, new PortIdToSubportKey(interfaceName)).build();
1054 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1055 .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1056 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1057 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1058 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1059 .getValue())).build();
1063 static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1064 return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1065 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1068 // TODO Remove this method entirely
1069 @SuppressWarnings("checkstyle:IllegalCatch")
1070 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1072 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1073 } catch (ReadFailedException e) {
1074 throw new RuntimeException(e);
1079 static ProviderTypes getProviderNetworkType(Network network) {
1080 if (network == null) {
1081 LOG.error("Error in getting provider network type since network is null");
1084 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1086 Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1087 if (networkTypeBase != null) {
1088 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1089 return ProviderTypes.FLAT;
1090 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1091 return ProviderTypes.VLAN;
1092 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1093 return ProviderTypes.VXLAN;
1094 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1095 return ProviderTypes.GRE;
1099 LOG.error("Error in getting provider network type since network provider extension is null for network "
1100 + "{}", network.getUuid().getValue());
1104 static boolean isNetworkTypeSupported(Network network) {
1105 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1106 return npe != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1109 static boolean isFlatOrVlanNetwork(Network network) {
1110 if (network != null) {
1111 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1113 Class<? extends NetworkTypeBase> npeType = npe.getNetworkType();
1114 if (npeType != null) {
1115 return NetworkTypeVlan.class.isAssignableFrom(npeType)
1116 || NetworkTypeFlat.class.isAssignableFrom(npeType);
1123 static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1124 return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1128 * Get inter-VPN link state.
1130 * @param vpnLinkName VPN link name
1131 * @return Optional of InterVpnLinkState
1133 public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1134 InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1135 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1136 return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1140 * Returns an InterVpnLink by searching by one of its endpoint's IP.
1142 * @param endpointIp IP to search for
1143 * @return a InterVpnLink
1145 public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1146 InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1147 Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1149 if (interVpnLinksOpData.isPresent()) {
1150 for (InterVpnLink interVpnLink : interVpnLinksOpData.get().nonnullInterVpnLink()) {
1151 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1152 || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1153 return Optional.of(interVpnLink);
1157 return Optional.absent();
1160 protected Integer releaseId(String poolName, String idKey) {
1161 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1163 Future<RpcResult<ReleaseIdOutput>> result = idManager.releaseId(idInput);
1164 if (result == null || result.get() == null || !result.get().isSuccessful()) {
1165 LOG.error("releaseId: RPC Call to release Id from pool {} with key {} returned with Errors {}",
1166 poolName, idKey, (result != null && result.get() != null) ? result.get().getErrors() :
1167 "RpcResult is null");
1169 return result.get().getResult().getIdValues().get(0).intValue();
1171 } catch (InterruptedException | ExecutionException e) {
1172 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
1174 return NeutronConstants.INVALID_ID;
1177 protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1178 byte[] octets = bytesFromHexString(mac.getValue());
1180 /* As per the RFC2373, steps involved to generate a LLA include
1181 1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1182 between OUI and NIC Specific part.
1183 2. Invert the Universal/Local flag in the OUI portion of the address.
1184 3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1185 identifier to generate the IPv6 LLA. */
1187 StringBuilder interfaceID = new StringBuilder();
1188 short u8byte = (short) (octets[0] & 0xff);
1190 interfaceID.append(Integer.toHexString(0xFF & u8byte));
1191 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1192 interfaceID.append(":");
1193 interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1194 interfaceID.append("ff:fe");
1195 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1196 interfaceID.append(":");
1197 interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1198 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1200 Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1201 IpAddress ipAddress = new IpAddress(ipv6LLA);
1205 protected static byte[] bytesFromHexString(String values) {
1207 if (values != null) {
1210 String[] octets = target.split(":");
1212 byte[] ret = new byte[octets.length];
1213 for (int i = 0; i < octets.length; i++) {
1214 ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1219 public List<String> getExistingRDs() {
1220 List<String> existingRDs = new ArrayList<>();
1221 InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1222 Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1223 if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1224 for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1225 List<String> rds = vpnInstance.getRouteDistinguisher();
1227 existingRDs.addAll(rds);
1234 protected boolean doesVpnExist(Uuid vpnId) {
1235 return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId)).isPresent();
1238 protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1239 .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1240 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1241 .rev160111.external.subnets.Subnets> subnetsIdentifier =
1242 InstanceIdentifier.builder(ExternalSubnets.class)
1243 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1244 .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1245 return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1248 public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1249 PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1250 List<FixedIps> fixedIps = port.getFixedIps();
1251 IpAddress ipAddress = null;
1252 if (isNotEmpty(fixedIps)) {
1253 ipAddress = port.getFixedIps().get(0).getIpAddress();
1255 StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1256 List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1257 if (ipAddress != null) {
1258 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1260 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1262 return staticMacEntries;
1265 public static boolean isEmpty(Collection<?> collection) {
1266 return collection == null || collection.isEmpty();
1269 public static boolean isNotEmpty(Collection<?> collection) {
1270 return !isEmpty(collection);
1274 * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1275 * @param routerUuid the Uuid for which find out the IP version associated
1276 * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1278 public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1279 IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1280 if (routerUuid == null) {
1283 List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1284 if (subnetmapList.isEmpty()) {
1287 for (Subnetmap sn : subnetmapList) {
1288 if (sn.getSubnetIp() != null) {
1289 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1290 if (rep.choice != ipVers.choice) {
1291 rep = rep.addVersion(ipVers);
1293 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1301 /**This method return the list of Subnetmap associated to the router or a empty list if any.
1302 * @param routerId the Uuid of router for which subnetmap is find out
1303 * @return a list of Subnetmap associated to the router. it could be empty if any
1305 protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1306 List<Subnetmap> subnetIdList = new ArrayList<>();
1307 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
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 VPN_INSTANCE_OP_DATA_IID.child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd));
1397 public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1398 int subnetCount = -1;
1399 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1400 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1401 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1402 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1404 //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1407 /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1408 * for the VPN Instance.
1410 * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1411 * for the VPN Instance.
1413 if (add && subnetCount == 1) {
1415 } else if (!add && subnetCount == 0) {
1422 public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1426 Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1427 // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1428 List<IpVersionChoice> snIpVersions = new ArrayList<>();
1429 for (Subnetmap snMap : allSubnetMaps.get().nonnullSubnetmap()) {
1430 if (snMap.getId().equals(sm.getId())) {
1433 if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1434 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1436 if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1437 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1440 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1441 if (!snIpVersions.contains(ipVersion)) {
1447 public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1448 List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1449 int subnetCount = 0;
1450 for (Subnetmap subMap : subnetMapList) {
1451 IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1452 if (ipVersion.isIpVersionChosen(ipVer)) {
1455 if (subnetCount > 1) {
1462 public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1463 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1464 VpnInstance vpnInstance = getVpnInstance(dataBroker, new Uuid(vpnName));
1465 if (vpnInstance == null) {
1466 return Collections.emptyList();
1468 if (vpnInstance.isL2vpn()) {
1469 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1470 + "VpnInstance is L2 instance. Do nothing.", vpnName, ipVersion);
1471 return Collections.emptyList();
1473 if (ipVersion == IpVersionChoice.UNDEFINED) {
1474 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1475 + "is not allowed. Do nothing", vpnName);
1476 return Collections.emptyList();
1478 VpnInstanceBuilder builder = new VpnInstanceBuilder(vpnInstance);
1479 boolean ipConfigured = add;
1481 int originalValue = vpnInstance.getIpAddressFamilyConfigured().getIntValue();
1482 int updatedValue = ipVersion.choice;
1484 if (originalValue != updatedValue) {
1486 originalValue = originalValue == 0 ? updatedValue : updatedValue + originalValue;
1488 originalValue = 10 - updatedValue;
1490 } else if (!ipConfigured) {
1494 builder.setIpAddressFamilyConfigured(VpnInstance.IpAddressFamilyConfigured.forValue(originalValue));
1496 InstanceIdentifier<VpnInstance> vpnIdentifier = InstanceIdentifier.builder(VpnInstances.class)
1497 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
1498 LOG.info("updateVpnInstanceWithIpFamily: Successfully {} IP family {} to Vpn {}",
1499 add == true ? "added" : "removed", ipVersion, vpnName);
1500 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1501 CONFIGURATION, tx -> tx.merge(vpnIdentifier, builder.build(), false)));
1507 * Get the vpnInstance from its Uuid.
1509 * @param broker to get informations from ds
1510 * @param vpnId the Uuid of the VPN
1511 * @return the VpnInstance or null if unfindable
1514 public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1515 if (broker == null || vpnId == null) {
1518 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1519 new VpnInstanceKey(vpnId.getValue())).build();
1520 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1521 return vpnInstance.isPresent() ? vpnInstance.get() : null;
1525 *Get the Uuid of external network of the router (remember you that one router have only one external network).
1526 * @param routerId the Uuid of the router which you try to reach the external network
1527 * @return Uuid of externalNetwork or null if is not exist
1529 protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@NonNull Uuid routerId) {
1530 LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1531 Uuid externalNetworkUuid = null;
1532 Router router = getNeutronRouter(routerId);
1533 if (router != null && router.getExternalGatewayInfo() != null) {
1534 externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1536 return externalNetworkUuid;
1539 public Uuid getInternetvpnUuidBoundToRouterId(@NonNull Uuid routerId) {
1540 Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1541 if (netId == null) {
1544 return getVpnForNetwork(netId);
1548 * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1549 * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1550 * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1551 * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1552 * @return Uuid of externalVpn or null if it is not found
1555 public Uuid getInternetvpnUuidBoundToSubnetRouter(@NonNull Uuid subnetUuid) {
1556 Subnetmap subnetmap = getSubnetmap(subnetUuid);
1557 Uuid routerUuid = subnetmap.getRouterId();
1558 LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1559 if (routerUuid == null) {
1562 Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1563 return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1567 * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1568 * @param extNet Provider Network, which has a port attached as external network gateway to router
1569 * @return a list of Private Subnetmap Ids of the router with external network gateway
1571 public @NonNull List<Uuid> getPrivateSubnetsToExport(@NonNull Network extNet, Uuid internetVpnId) {
1572 List<Uuid> subList = new ArrayList<>();
1573 List<Uuid> rtrList = new ArrayList<>();
1574 if (internetVpnId != null) {
1575 rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1577 Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1578 rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1580 if (rtrList.isEmpty()) {
1583 for (Uuid rtrId: rtrList) {
1584 Router router = getNeutronRouter(rtrId);
1585 ExternalGatewayInfo info = router.getExternalGatewayInfo();
1587 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1588 router.getUuid().getValue());
1591 // check that router really has given provider network as its external gateway port
1592 if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1593 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1594 router.getUuid().getValue(), extNet.getUuid().getValue());
1597 subList.addAll(getNeutronRouterSubnetIds(rtrId));
1602 public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1603 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1604 if (vpnInstanceOpDataEntry == null) {
1605 LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1608 Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId().toJava();
1609 List<Uuid> routerIds = new ArrayList<>();
1610 //Handle router specific V6 internet fallback flow else handle all V6 external routers
1611 if (routerId != null) {
1612 routerIds.add(routerId);
1614 //This block will execute for ext-nw to Internet VPN association/disassociation event.
1615 routerIds = getRouterIdListforVpn(vpnName);
1617 if (routerIds == null || routerIds.isEmpty()) {
1618 LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1621 for (Uuid rtrId: routerIds) {
1622 if (rtrId == null) {
1625 List<Uint64> dpnIds = getDpnsForRouter(rtrId.getValue());
1626 if (dpnIds.isEmpty()) {
1629 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1630 Long routerIdAsLong = vpnOpDataEntry.getVpnId().toJava();
1632 Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1633 if (rtrVpnId == null) {
1634 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1635 vpnId = routerIdAsLong;
1637 vpnId = getVpnId(rtrVpnId.getValue());
1639 for (Uint64 dpnId : dpnIds) {
1641 LoggingFutures.addErrorLogging(
1642 txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
1643 tx -> ipV6InternetDefRt.installDefaultRoute(tx, dpnId, rtrId.getValue(),
1644 internetBgpVpnId, vpnId)), LOG, "Error adding default route");
1646 LoggingFutures.addErrorLogging(
1647 txRunner.callWithNewReadWriteTransactionAndSubmit(Datastore.CONFIGURATION,
1648 tx -> ipV6InternetDefRt.removeDefaultRoute(tx, dpnId, rtrId.getValue(),
1649 internetBgpVpnId, vpnId)), LOG,
1650 "Error removing default route");
1656 public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @NonNull Uuid vpn) {
1657 String primaryRd = getVpnRd(vpn.getValue());
1658 if (primaryRd == null) {
1659 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1660 + "Primary RD not found", choice, vpn.getValue());
1663 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1665 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1666 read(LogicalDatastoreType.OPERATIONAL, id);
1667 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1668 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1669 + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1672 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1673 if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1674 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1675 + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1678 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1679 builder.setBgpvpnType(choice);
1680 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1681 tx.merge(id, builder.build(), false);
1682 LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1683 }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1686 public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1687 return new RouterIdsBuilder().setRouterId(routerId).build();
1690 public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1691 List<RouterIds> listRouterIds = new ArrayList<>();
1692 for (Uuid routerId : routerIds) {
1693 final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1694 listRouterIds.add(routerIdInstance);
1696 return listRouterIds;
1700 public List<Uint64> getDpnsForRouter(String routerUuid) {
1701 InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1702 .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1703 Optional<RouterDpnList> routerDpnListData =
1704 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1705 LogicalDatastoreType.OPERATIONAL, id);
1706 List<Uint64> dpns = new ArrayList<>();
1707 if (routerDpnListData.isPresent()) {
1708 for (DpnVpninterfacesList dpnVpnInterface : routerDpnListData.get().nonnullDpnVpninterfacesList()) {
1709 dpns.add(dpnVpnInterface.getDpnId());
1716 List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1717 List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1718 if (subnetIdList != null) {
1719 List<Subnetmap> subnetmapList = new ArrayList<>();
1720 for (Uuid subnetId : subnetIdList) {
1721 Subnetmap subnetmap = getSubnetmap(subnetId);
1722 if (subnetmap != null) {
1723 subnetmapList.add(subnetmap);
1725 LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1726 subnetId.getValue(), networkId.getValue());
1729 return subnetmapList;
1731 LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1732 networkId.getValue());
1737 public long getVpnId(String vpnName) {
1738 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1739 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1740 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1741 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1742 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1743 .VpnInstance::getVpnId).orElse(null).toJava();
1746 protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1747 List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1748 for (Subnetmap sm : subnetList) {
1752 IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1753 //skip further subnet processing once found first V6 subnet for the router
1754 if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1761 @SuppressWarnings({ "unchecked", "rawtypes" })
1762 public <T extends DataObject> void asyncReadAndExecute(final LogicalDatastoreType datastoreType,
1763 final InstanceIdentifier<T> iid, final String jobKey,
1764 final Function<Optional<T>, Void> function) {
1765 jobCoordinator.enqueueJob(jobKey, () -> {
1766 SettableFuture<Optional<T>> settableFuture = SettableFuture.create();
1767 List futures = Collections.singletonList(settableFuture);
1768 try (ReadOnlyTransaction tx = dataBroker.newReadOnlyTransaction()) {
1769 Futures.addCallback(tx.read(datastoreType, iid),
1770 new SettableFutureCallback<Optional<T>>(settableFuture) {
1772 public void onSuccess(Optional<T> data) {
1773 function.apply(data);
1774 super.onSuccess(data);
1776 }, MoreExecutors.directExecutor());
1780 }, JOB_MAX_RETRIES);
1783 private static InstanceIdentifier<VpnMap> vpnMapIdentifier(Uuid uuid) {
1784 return VPN_MAPS_IID.child(VpnMap.class, new VpnMapKey(uuid));
1787 private class SettableFutureCallback<T> implements FutureCallback<T> {
1789 private final SettableFuture<T> settableFuture;
1791 SettableFutureCallback(SettableFuture<T> settableFuture) {
1792 this.settableFuture = settableFuture;
1796 public void onSuccess(T objT) {
1797 settableFuture.set(objT);
1801 public void onFailure(Throwable throwable) {
1802 settableFuture.setException(throwable);