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.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;
31 import java.util.Optional;
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.genius.datastoreutils.SingleTransactionDataBroker;
44 import org.opendaylight.genius.infra.Datastore;
45 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
46 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
47 import org.opendaylight.genius.infra.TypedWriteTransaction;
48 import org.opendaylight.genius.mdsalutil.MDSALUtil;
49 import org.opendaylight.genius.utils.JvmGlobalLocks;
50 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
51 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
52 import org.opendaylight.mdsal.binding.api.DataBroker;
53 import org.opendaylight.mdsal.binding.api.ReadTransaction;
54 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
55 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
56 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronConstants;
57 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAcl;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfo;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.SubnetInfoKey;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInstances;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInterfaces;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstanceBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstanceKey;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterface;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterfaceKey;
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.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap.RouterIdsKey;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIpsKey;
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().values())) {
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().values())) {
296 Map<RouterIdsKey, org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602
297 .vpnmaps.vpnmap.RouterIds> keyRouterIdsMap = vpnMap.nonnullRouterIds();
298 if (keyRouterIdsMap == null || keyRouterIdsMap.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 (keyRouterIdsMap.values().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(new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight
349 .netvirt.neutronvpn.rev150602.vpnmaps.vpnmap.RouterIds>(vpnMap.nonnullRouterIds().values()));
351 LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
356 protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
357 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId));
358 if (optionalVpnMap.isPresent()) {
359 VpnMap vpnMap = optionalVpnMap.get();
360 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
361 return new ArrayList<>(vpnMap.getNetworkIds());
366 LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
370 protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
371 List<Uuid> subnets = new ArrayList<>();
373 Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
374 if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
375 Map<SubnetmapKey, Subnetmap> keySubnetmapMap = subnetmaps.get().getSubnetmap();
376 for (Subnetmap candidateSubnetMap : keySubnetmapMap.values()) {
377 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
378 subnets.add(candidateSubnetMap.getId());
386 protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
387 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
388 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
389 if (vpnPortipToPortData.isPresent()) {
390 return vpnPortipToPortData.get().getPortName();
392 LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
393 + " fixed IP {}", vpnName, fixedIp);
398 protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
399 InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
400 Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
401 if (optionalNetworkMap.isPresent()) {
402 return optionalNetworkMap.get().getSubnetIdList();
404 LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
408 protected Router getNeutronRouter(Uuid routerId) {
409 Router router = routerMap.get(routerId);
410 if (router != null) {
413 Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, getNeutronRouterIid(routerId));
414 if (rtr.isPresent()) {
420 public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
421 return NEUTRON_ROUTERS_IID.child(Router.class, new RouterKey(routerId));
424 protected @Nullable Network getNeutronNetwork(Uuid networkId) {
425 Network network = networkMap.get(networkId);
426 if (network != null) {
429 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
430 InstanceIdentifier<Network> inst = NEUTRON_NETWORKS_IID.child(Network.class, new NetworkKey(networkId));
431 return read(LogicalDatastoreType.CONFIGURATION, inst).orElse(null);
434 protected @Nullable Port getNeutronPort(Uuid portId) {
435 Port prt = portMap.get(portId);
439 LOG.debug("getNeutronPort for {}", portId.getValue());
440 InstanceIdentifier<Port> inst = NEUTRON_PORTS_IID.child(Port.class, new PortKey(portId));
441 return read(LogicalDatastoreType.CONFIGURATION, inst).orElse(null);
444 public PortIdToSubport getPortIdToSubport(Uuid portId) {
445 InstanceIdentifier<PortIdToSubport> portIdToSubportIdentifier = buildPortIdSubportMappingIdentifier(portId);
446 Optional<PortIdToSubport> optionalPortIdToSubport = read(LogicalDatastoreType.CONFIGURATION,
447 portIdToSubportIdentifier);
448 if (optionalPortIdToSubport.isPresent()) {
449 return optionalPortIdToSubport.get();
451 LOG.error("getPortIdToSubport failed, PortIdToSubport {} not present", portId.getValue());
455 protected static boolean isDhcpServerPort(Port port) {
456 return port.getDeviceOwner().equals("network:dhcp");
459 protected InterfaceAcl getDhcpInterfaceAcl(Port port) {
460 InterfaceAclBuilder interfaceAclBuilder = new InterfaceAclBuilder();
461 interfaceAclBuilder.setPortSecurityEnabled(false);
462 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.DhcpService);
463 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
464 port.getMacAddress(), new ArrayList<FixedIps>(port.nonnullFixedIps().values()));
465 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
466 return interfaceAclBuilder.build();
470 * Returns port_security_enabled status with the port.
472 * @param port the port
473 * @return port_security_enabled status
475 protected static boolean getPortSecurityEnabled(Port port) {
476 String deviceOwner = port.getDeviceOwner();
477 if (deviceOwner != null && deviceOwner.startsWith("network:")) {
478 // port with device owner of network:xxx is created by
479 // neutorn for its internal use. So security group doesn't apply.
480 // router interface, dhcp port and floating ip.
483 PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
484 if (portSecurity != null) {
485 return portSecurity.isPortSecurityEnabled();
491 * Gets security group UUIDs delta .
493 * @param port1SecurityGroups the port 1 security groups
494 * @param port2SecurityGroups the port 2 security groups
495 * @return the security groups delta
498 protected static List<Uuid> getSecurityGroupsDelta(@Nullable List<Uuid> port1SecurityGroups,
499 @Nullable List<Uuid> port2SecurityGroups) {
500 if (port1SecurityGroups == null) {
504 if (port2SecurityGroups == null) {
505 return port1SecurityGroups;
508 List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
509 List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
510 for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
511 Uuid securityGroup1 = iterator.next();
512 for (Uuid securityGroup2 : list2) {
513 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
523 * Gets the fixed ips delta.
525 * @param port1FixedIps the port 1 fixed ips
526 * @param port2FixedIps the port 2 fixed ips
527 * @return the fixed ips delta
529 protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
530 if (port1FixedIps == null) {
534 if (port2FixedIps == null) {
535 return port1FixedIps;
538 List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
539 List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
540 for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
541 FixedIps fixedIps1 = iterator.next();
542 for (FixedIps fixedIps2 : list2) {
543 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
553 * Gets the allowed address pairs delta.
555 * @param port1AllowedAddressPairs the port 1 allowed address pairs
556 * @param port2AllowedAddressPairs the port 2 allowed address pairs
557 * @return the allowed address pairs delta
560 protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
561 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
562 .AllowedAddressPairs> port1AllowedAddressPairs,
563 @Nullable List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
564 .AllowedAddressPairs> port2AllowedAddressPairs) {
565 if (port1AllowedAddressPairs == null) {
569 if (port2AllowedAddressPairs == null) {
570 return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
573 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
574 .AllowedAddressPairs> list1 =
575 new ArrayList<>(port1AllowedAddressPairs);
576 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
577 .AllowedAddressPairs> list2 =
578 new ArrayList<>(port2AllowedAddressPairs);
579 for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
580 .AllowedAddressPairs> iterator =
581 list1.iterator(); iterator.hasNext();) {
582 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
583 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
584 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
585 .AllowedAddressPairs allowedAddressPair2 : list2) {
586 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
592 return getAllowedAddressPairsForAclService(list1);
596 * Gets the acl allowed address pairs.
598 * @param macAddress the mac address
599 * @param ipAddress the ip address
600 * @return the acl allowed address pairs
602 protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
603 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
604 AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
605 aclAllowedAdressPairBuilder.setMacAddress(macAddress);
606 if (ipAddress != null && ipAddress.stringValue() != null) {
607 if (ipAddress.getIpPrefix() != null) {
608 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
610 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
613 return aclAllowedAdressPairBuilder.build();
617 * Gets the allowed address pairs for acl service.
619 * @param macAddress the mac address
620 * @param fixedIps the fixed ips
621 * @return the allowed address pairs for acl service
623 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
624 List<FixedIps> fixedIps) {
625 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
626 for (FixedIps fixedIp : fixedIps) {
627 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
628 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
629 .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
631 return aclAllowedAddressPairs;
635 * Gets the allowed address pairs for acl service.
637 * @param portAllowedAddressPairs the port allowed address pairs
638 * @return the allowed address pairs for acl service
640 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
641 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
642 .AllowedAddressPairs> portAllowedAddressPairs) {
643 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
644 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
645 portAllowedAddressPair : portAllowedAddressPairs) {
646 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
647 portAllowedAddressPair.getIpAddress()));
649 return aclAllowedAddressPairs;
653 * Gets the IPv6 Link Local Address corresponding to the MAC Address.
655 * @param macAddress the mac address
656 * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
658 protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
659 IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
660 return getAclAllowedAddressPairs(macAddress,
661 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
663 ipv6LinkLocalAddress.stringValue()));
667 * Gets the updated security groups.
669 * @param aclInterfaceSecurityGroups the acl interface security groups
670 * @param origSecurityGroups the orig security groups
671 * @param newSecurityGroups the new security groups
672 * @return the updated security groups
674 protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
675 List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
676 List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
677 List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
678 List<Uuid> updatedSecurityGroups =
679 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
680 if (addedGroups != null) {
681 updatedSecurityGroups.addAll(addedGroups);
683 if (deletedGroups != null) {
684 updatedSecurityGroups.removeAll(deletedGroups);
686 return updatedSecurityGroups;
690 * Gets the allowed address pairs for fixed ips.
692 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
693 * @param portMacAddress the port mac address
694 * @param origFixedIps the orig fixed ips
695 * @param newFixedIps the new fixed ips
696 * @return the allowed address pairs for fixed ips
698 protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
699 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
700 @Nullable Map<FixedIpsKey, FixedIps> origFixedIps, Collection<FixedIps> newFixedIps) {
701 List<FixedIps> addedFixedIps = getFixedIpsDelta(new ArrayList<FixedIps>(newFixedIps),
702 new ArrayList<FixedIps>(origFixedIps.values()));
703 List<FixedIps> deletedFixedIps = getFixedIpsDelta(new ArrayList<FixedIps>(origFixedIps.values()),
704 new ArrayList<FixedIps>(newFixedIps));
705 List<AllowedAddressPairs> updatedAllowedAddressPairs =
706 aclInterfaceAllowedAddressPairs != null
707 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
708 if (deletedFixedIps != null) {
709 updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
711 if (addedFixedIps != null) {
712 updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
714 return updatedAllowedAddressPairs;
718 * Gets the updated allowed address pairs.
720 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
721 * @param origAllowedAddressPairs the orig allowed address pairs
722 * @param newAllowedAddressPairs the new allowed address pairs
723 * @return the updated allowed address pairs
725 protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
726 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
727 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
728 .AllowedAddressPairs> origAllowedAddressPairs,
729 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
730 .AllowedAddressPairs> newAllowedAddressPairs) {
731 List<AllowedAddressPairs> addedAllowedAddressPairs =
732 getAllowedAddressPairsDelta(new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports
733 .rev150712.port.attributes.AllowedAddressPairs>(newAllowedAddressPairs),
734 new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port
735 .attributes.AllowedAddressPairs>(origAllowedAddressPairs));
736 List<AllowedAddressPairs> deletedAllowedAddressPairs =
737 getAllowedAddressPairsDelta(new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports
738 .rev150712.port.attributes.AllowedAddressPairs>(origAllowedAddressPairs),
739 new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port
740 .attributes.AllowedAddressPairs>(newAllowedAddressPairs));
741 List<AllowedAddressPairs> updatedAllowedAddressPairs =
742 aclInterfaceAllowedAddressPairs != null
743 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
744 if (addedAllowedAddressPairs != null) {
745 updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
747 if (deletedAllowedAddressPairs != null) {
748 updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
750 return updatedAllowedAddressPairs;
754 * Populate interface acl builder.
756 * @param interfaceAclBuilder the interface acl builder
757 * @param port the port
759 protected void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
760 // Handle security group enabled
761 List<Uuid> securityGroups = port.getSecurityGroups();
762 if (securityGroups != null) {
763 interfaceAclBuilder.setSecurityGroups(securityGroups);
765 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
766 port.getMacAddress(), new ArrayList<FixedIps>(port.nonnullFixedIps().values()));
767 // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
768 aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
769 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
770 portAllowedAddressPairs = new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports
771 .rev150712.port.attributes.AllowedAddressPairs>(port.nonnullAllowedAddressPairs().values());
772 if (portAllowedAddressPairs != null) {
773 aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
775 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
776 interfaceAclBuilder.setInterfaceType(InterfaceAcl.InterfaceType.AccessPort);
777 populateSubnetInfo(interfaceAclBuilder, port);
780 protected void populateSubnetInfo(InterfaceAclBuilder interfaceAclBuilder, Port port) {
781 List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
782 if (portSubnetInfo != null) {
783 interfaceAclBuilder.setSubnetInfo(portSubnetInfo);
788 protected List<SubnetInfo> getSubnetInfo(Port port) {
789 Map<FixedIpsKey, FixedIps> keyFixedIpsMap = port.getFixedIps();
790 if (keyFixedIpsMap == null) {
791 LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
794 List<SubnetInfo> subnetInfoList = new ArrayList<>();
795 for (FixedIps portFixedIp : keyFixedIpsMap.values()) {
796 Uuid subnetId = portFixedIp.getSubnetId();
797 Subnet subnet = getNeutronSubnet(subnetId);
798 if (subnet != null) {
799 Class<? extends IpVersionBase> ipVersion =
800 NeutronSecurityGroupConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
801 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
802 : NeutronSecurityGroupConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
803 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
804 .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
805 .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
806 subnetInfoList.add(subnetInfo);
809 return subnetInfoList;
812 protected Subnet getNeutronSubnet(Uuid subnetId) {
813 Subnet subnet = subnetMap.get(subnetId);
814 if (subnet != null) {
817 InstanceIdentifier<Subnet> inst = NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(subnetId));
818 Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
820 if (sn.isPresent()) {
822 addToSubnetCache(subnet);
827 protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
828 List<Subnetmap> subnetMapList = new ArrayList<>();
829 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
830 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
831 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap().values()) {
832 if (routerId.equals(subnetmap.getRouterId())) {
833 subnetMapList.add(subnetmap);
837 LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
838 return subnetMapList;
842 protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
843 LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
844 List<Uuid> subnetIdList = new ArrayList<>();
845 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
846 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
847 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap().values()) {
848 if (routerId.equals(subnetmap.getRouterId())) {
849 subnetIdList.add(subnetmap.getId());
853 LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
857 // TODO Clean up the exception handling and the console output
858 @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
860 protected Short getIPPrefixFromPort(Port port) {
862 // FIXME: why are we not using getNeutronSubnet() here? it does caching for us...
863 Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION,
864 NEUTRON_SUBNETS_IID.child(Subnet.class, new SubnetKey(
865 new ArrayList<FixedIps>(port.nonnullFixedIps().values()).get(0).getSubnetId())));
866 if (subnet.isPresent()) {
867 String cidr = subnet.get().getCidr().stringValue();
868 // Extract the prefix length from cidr
869 String[] parts = cidr.split("/");
870 if (parts.length == 2) {
871 return Short.valueOf(parts[1]);
873 LOG.trace("Could not retrieve prefix from subnet CIDR");
876 LOG.trace("Unable to read on subnet datastore");
878 } catch (Exception e) {
879 LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
881 LOG.error("Failed for port {}", port.getUuid().getValue());
885 // TODO Clean up the exception handling
886 @SuppressWarnings("checkstyle:IllegalCatch")
887 protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
888 boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
889 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
890 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
891 .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
892 .setVpnName(vpnName).setPortFixedip(fixedIp)
893 .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
895 if (writeConfigTxn != null) {
896 writeConfigTxn.put(id, builder.build());
898 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
900 LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
901 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
902 } catch (Exception e) {
903 LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {} for port {} with "
904 + "macAddress {}", vpnName, fixedIp, portName, macAddress, e);
908 // TODO Clean up the exception handling
909 @SuppressWarnings("checkstyle:IllegalCatch")
910 protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
911 TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
912 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
914 if (writeConfigTxn != null) {
915 writeConfigTxn.delete(id);
917 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
919 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from VpnPortipToPort DS", fixedIp,
921 } catch (Exception e) {
922 LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
927 // TODO Clean up the exception handling
928 @SuppressWarnings("checkstyle:IllegalCatch")
929 protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
930 InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
931 // FIXME: can we use 'id' as the lock name?
932 final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnName + fixedIp);
935 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
936 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
938 } catch (Exception e) {
939 LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
940 vpnName, fixedIp, e);
946 public void addToNetworkCache(Network network) {
947 networkMap.put(network.getUuid(), network);
950 public void removeFromNetworkCache(Network network) {
951 networkMap.remove(network.getUuid());
954 public void addToRouterCache(Router router) {
955 routerMap.put(router.getUuid(), router);
958 public void removeFromRouterCache(Router router) {
959 routerMap.remove(router.getUuid());
962 public Collection<Router> getAllRouters() {
963 return routerMap.values();
966 public void addToPortCache(Port port) {
967 portMap.put(port.getUuid(), port);
970 public void removeFromPortCache(Port port) {
971 portMap.remove(port.getUuid());
974 public void addToSubnetCache(Subnet subnet) {
975 subnetMap.put(subnet.getUuid(), subnet);
976 IpAddress gatewayIp = subnet.getGatewayIp();
977 if (gatewayIp != null) {
978 subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
982 public void removeFromSubnetCache(Subnet subnet) {
983 subnetMap.remove(subnet.getUuid());
984 IpAddress gatewayIp = subnet.getGatewayIp();
985 if (gatewayIp != null) {
986 Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
988 gwIps.remove(subnet.getUuid());
993 public static String getSegmentationIdFromNeutronNetwork(Network network) {
994 String segmentationId = null;
995 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
996 if (providerExtension != null) {
997 Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
998 segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
1001 return segmentationId;
1004 public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
1005 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
1006 return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
1009 public static String getPhysicalNetworkName(Network network) {
1010 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
1011 return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
1014 public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
1015 return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
1018 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1019 InstanceIdentifier<VpnPortipToPort> id =
1020 InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
1021 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
1025 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
1026 InstanceIdentifier<LearntVpnVipToPort> id =
1027 InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1028 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1032 static Boolean getIsExternal(Network network) {
1033 NetworkL3Extension ext = network.augmentation(NetworkL3Extension.class);
1034 return ext != null && ext.isExternal();
1037 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1038 InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1039 NetworkMapKey(networkId)).build();
1043 static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1044 InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1045 .class, new VpnInterfaceKey(ifName)).build();
1049 static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1050 return SUBNETMAPS_IID.child(Subnetmap.class, new SubnetmapKey(subnetId));
1053 static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1054 InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1055 InterfaceKey(interfaceName)).build();
1059 static InstanceIdentifier<PortIdToSubport> buildPortIdSubportMappingIdentifier(Uuid interfaceName) {
1060 InstanceIdentifier<PortIdToSubport> id = InstanceIdentifier.builder(NeutronVpnPortIdSubportData.class)
1061 .child(PortIdToSubport.class, new PortIdToSubportKey(interfaceName)).build();
1065 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1066 .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1067 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1068 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1069 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1070 .getValue())).build();
1074 static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1075 return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1076 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1079 // TODO Remove this method entirely
1080 @SuppressWarnings("checkstyle:IllegalCatch")
1081 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1083 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1084 } catch (ExecutionException | InterruptedException e) {
1085 throw new RuntimeException(e);
1090 static ProviderTypes getProviderNetworkType(Network network) {
1091 if (network == null) {
1092 LOG.error("Error in getting provider network type since network is null");
1095 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1097 Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1098 if (networkTypeBase != null) {
1099 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1100 return ProviderTypes.FLAT;
1101 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1102 return ProviderTypes.VLAN;
1103 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1104 return ProviderTypes.VXLAN;
1105 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1106 return ProviderTypes.GRE;
1110 LOG.error("Error in getting provider network type since network provider extension is null for network "
1111 + "{}", network.getUuid().getValue());
1115 static boolean isNetworkTypeSupported(Network network) {
1116 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1117 return npe != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1120 static boolean isFlatOrVlanNetwork(Network network) {
1121 if (network != null) {
1122 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1124 Class<? extends NetworkTypeBase> npeType = npe.getNetworkType();
1125 if (npeType != null) {
1126 return NetworkTypeVlan.class.isAssignableFrom(npeType)
1127 || NetworkTypeFlat.class.isAssignableFrom(npeType);
1134 static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1135 return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1139 * Get inter-VPN link state.
1141 * @param vpnLinkName VPN link name
1142 * @return Optional of InterVpnLinkState
1144 public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1145 InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1146 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1147 return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1151 * Returns an InterVpnLink by searching by one of its endpoint's IP.
1153 * @param endpointIp IP to search for
1154 * @return a InterVpnLink
1156 public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1157 InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1158 Optional<InterVpnLinks> interVpnLinksOpData = null;
1160 interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1162 if (interVpnLinksOpData.isPresent()) {
1163 for (InterVpnLink interVpnLink : interVpnLinksOpData.get().nonnullInterVpnLink().values()) {
1164 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1165 || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1166 return Optional.of(interVpnLink);
1170 } catch (ExecutionException | InterruptedException e) {
1171 LOG.error("getInterVpnLinkByEndpointIp: Exception when reading intervpn Links for endpoint Ip {} ",
1174 return Optional.empty();
1177 protected Integer releaseId(String poolName, String idKey) {
1178 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1180 Future<RpcResult<ReleaseIdOutput>> result = idManager.releaseId(idInput);
1181 if (result == null || result.get() == null || !result.get().isSuccessful()) {
1182 LOG.error("releaseId: RPC Call to release Id from pool {} with key {} returned with Errors {}",
1183 poolName, idKey, (result != null && result.get() != null) ? result.get().getErrors() :
1184 "RpcResult is null");
1186 return result.get().getResult().getIdValues().get(0).intValue();
1188 } catch (InterruptedException | ExecutionException e) {
1189 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
1191 return NeutronConstants.INVALID_ID;
1194 protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1195 byte[] octets = bytesFromHexString(mac.getValue());
1197 /* As per the RFC2373, steps involved to generate a LLA include
1198 1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1199 between OUI and NIC Specific part.
1200 2. Invert the Universal/Local flag in the OUI portion of the address.
1201 3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1202 identifier to generate the IPv6 LLA. */
1204 StringBuilder interfaceID = new StringBuilder();
1205 short u8byte = (short) (octets[0] & 0xff);
1207 interfaceID.append(Integer.toHexString(0xFF & u8byte));
1208 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1209 interfaceID.append(":");
1210 interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1211 interfaceID.append("ff:fe");
1212 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1213 interfaceID.append(":");
1214 interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1215 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1217 Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1218 IpAddress ipAddress = new IpAddress(ipv6LLA);
1222 protected static byte[] bytesFromHexString(String values) {
1224 if (values != null) {
1227 String[] octets = target.split(":");
1229 byte[] ret = new byte[octets.length];
1230 for (int i = 0; i < octets.length; i++) {
1231 ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1236 public List<String> getExistingRDs() {
1237 List<String> existingRDs = new ArrayList<>();
1238 InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1239 Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1240 if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1241 for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance().values()) {
1242 List<String> rds = vpnInstance.getRouteDistinguisher();
1244 existingRDs.addAll(rds);
1251 protected boolean doesVpnExist(Uuid vpnId) {
1252 return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier(vpnId)).isPresent();
1255 protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1256 .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1257 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1258 .rev160111.external.subnets.Subnets> subnetsIdentifier =
1259 InstanceIdentifier.builder(ExternalSubnets.class)
1260 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1261 .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1262 return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1265 public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1266 PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1267 Map<FixedIpsKey, FixedIps> keyFixedIpsMap = port.nonnullFixedIps();
1268 IpAddress ipAddress = null;
1269 if (isNotEmpty(keyFixedIpsMap.values())) {
1270 ipAddress = new ArrayList<FixedIps>(port.nonnullFixedIps().values()).get(0).getIpAddress();
1272 StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1273 List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1274 if (ipAddress != null) {
1275 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1277 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1279 return staticMacEntries;
1282 public static boolean isEmpty(Collection<?> collection) {
1283 return collection == null || collection.isEmpty();
1286 public static boolean isNotEmpty(Collection<?> collection) {
1287 return !isEmpty(collection);
1291 * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1292 * @param routerUuid the Uuid for which find out the IP version associated
1293 * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1295 public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1296 IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1297 if (routerUuid == null) {
1300 List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1301 if (subnetmapList.isEmpty()) {
1304 for (Subnetmap sn : subnetmapList) {
1305 if (sn.getSubnetIp() != null) {
1306 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1307 if (rep.choice != ipVers.choice) {
1308 rep = rep.addVersion(ipVers);
1310 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1318 /**This method return the list of Subnetmap associated to the router or a empty list if any.
1319 * @param routerId the Uuid of router for which subnetmap is find out
1320 * @return a list of Subnetmap associated to the router. it could be empty if any
1322 protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1323 List<Subnetmap> subnetIdList = new ArrayList<>();
1324 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1325 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1326 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap().values()) {
1327 if (routerId.equals(subnetmap.getRouterId())) {
1328 subnetIdList.add(subnetmap);
1332 return subnetIdList;
1335 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1336 .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1337 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1338 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1339 .instance.to.vpn.id.VpnInstance.class,
1340 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1341 .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1345 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1346 * @param vpnName Name of the VPN
1348 * @return the route-distinguisher of the VPN
1351 public String getVpnRd(String vpnName) {
1352 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1353 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1354 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1355 LogicalDatastoreType.CONFIGURATION, id).map(
1356 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1357 .VpnInstance::getVrfId).orElse(null);
1360 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1361 * @param ipAddress String of an representation IP address V4 or V6
1362 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1364 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1365 IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1366 if (ipAddress.contains("/")) {
1367 ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1370 InetAddress address = InetAddress.getByName(ipAddress);
1371 if (address instanceof Inet4Address) {
1372 return IpVersionChoice.IPV4;
1373 } else if (address instanceof Inet6Address) {
1374 return IpVersionChoice.IPV6;
1376 } catch (UnknownHostException | SecurityException e) {
1377 LOG.error("getIpVersionFromString: could not find version for {}", ipAddress);
1382 /**Get IpVersionChoice from Uuid Subnet.
1383 * @param sm Subnetmap structure
1384 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1386 public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1387 if (sm != null && sm.getSubnetIp() != null) {
1388 return getIpVersionFromString(sm.getSubnetIp());
1390 return IpVersionChoice.UNDEFINED;
1394 public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1395 String primaryRd = getVpnRd(vpnName);
1396 if (primaryRd == null) {
1397 LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1398 + "Primary RD not found", vpnName);
1401 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1402 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1403 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1404 LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1407 return vpnInstanceOpDataEntryOptional.get();
1410 protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1411 return VPN_INSTANCE_OP_DATA_IID.child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd));
1414 public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1415 int subnetCount = -1;
1416 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1417 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1418 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1419 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1421 //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1424 /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1425 * for the VPN Instance.
1427 * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1428 * for the VPN Instance.
1430 if (add && subnetCount == 1) {
1432 } else if (!add && subnetCount == 0) {
1439 public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1443 Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, SUBNETMAPS_IID);
1444 // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1445 List<IpVersionChoice> snIpVersions = new ArrayList<>();
1446 for (Subnetmap snMap : allSubnetMaps.get().nonnullSubnetmap().values()) {
1447 if (snMap.getId().equals(sm.getId())) {
1450 if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1451 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1453 if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1454 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1457 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1458 if (!snIpVersions.contains(ipVersion)) {
1464 public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1465 List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1466 int subnetCount = 0;
1467 for (Subnetmap subMap : subnetMapList) {
1468 IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1469 if (ipVersion.isIpVersionChosen(ipVer)) {
1472 if (subnetCount > 1) {
1479 public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1480 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1481 VpnInstance vpnInstance = getVpnInstance(dataBroker, new Uuid(vpnName));
1482 if (vpnInstance == null) {
1483 return Collections.emptyList();
1485 if (vpnInstance.isL2vpn()) {
1486 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1487 + "VpnInstance is L2 instance. Do nothing.", vpnName, ipVersion);
1488 return Collections.emptyList();
1490 if (ipVersion == IpVersionChoice.UNDEFINED) {
1491 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1492 + "is not allowed. Do nothing", vpnName);
1493 return Collections.emptyList();
1495 VpnInstanceBuilder builder = new VpnInstanceBuilder(vpnInstance);
1496 boolean ipConfigured = add;
1498 int originalValue = vpnInstance.getIpAddressFamilyConfigured().getIntValue();
1499 int updatedValue = ipVersion.choice;
1501 if (originalValue != updatedValue) {
1503 originalValue = originalValue == 0 ? updatedValue : updatedValue + originalValue;
1505 originalValue = 10 - updatedValue;
1507 } else if (!ipConfigured) {
1511 builder.setIpAddressFamilyConfigured(VpnInstance.IpAddressFamilyConfigured.forValue(originalValue));
1513 InstanceIdentifier<VpnInstance> vpnIdentifier = InstanceIdentifier.builder(VpnInstances.class)
1514 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
1515 LOG.info("updateVpnInstanceWithIpFamily: Successfully {} IP family {} to Vpn {}",
1516 add == true ? "added" : "removed", ipVersion, vpnName);
1517 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1518 CONFIGURATION, tx -> tx.mergeParentStructureMerge(vpnIdentifier, builder.build())));
1524 * Get the vpnInstance from its Uuid.
1526 * @param broker to get informations from ds
1527 * @param vpnId the Uuid of the VPN
1528 * @return the VpnInstance or null if unfindable
1531 public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1532 if (broker == null || vpnId == null) {
1535 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1536 new VpnInstanceKey(vpnId.getValue())).build();
1537 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1538 return vpnInstance.isPresent() ? vpnInstance.get() : null;
1542 *Get the Uuid of external network of the router (remember you that one router have only one external network).
1543 * @param routerId the Uuid of the router which you try to reach the external network
1544 * @return Uuid of externalNetwork or null if is not exist
1546 protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@NonNull Uuid routerId) {
1547 LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1548 Uuid externalNetworkUuid = null;
1549 Router router = getNeutronRouter(routerId);
1550 if (router != null && router.getExternalGatewayInfo() != null) {
1551 externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1553 return externalNetworkUuid;
1556 public Uuid getInternetvpnUuidBoundToRouterId(@NonNull Uuid routerId) {
1557 Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1558 if (netId == null) {
1561 return getVpnForNetwork(netId);
1565 * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1566 * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1567 * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1568 * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1569 * @return Uuid of externalVpn or null if it is not found
1572 public Uuid getInternetvpnUuidBoundToSubnetRouter(@NonNull Uuid subnetUuid) {
1573 Subnetmap subnetmap = getSubnetmap(subnetUuid);
1574 Uuid routerUuid = subnetmap.getRouterId();
1575 LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1576 if (routerUuid == null) {
1579 Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1580 return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1584 * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1585 * @param extNet Provider Network, which has a port attached as external network gateway to router
1586 * @return a list of Private Subnetmap Ids of the router with external network gateway
1588 public @NonNull List<Uuid> getPrivateSubnetsToExport(@NonNull Network extNet, Uuid internetVpnId) {
1589 List<Uuid> subList = new ArrayList<>();
1590 List<Uuid> rtrList = new ArrayList<>();
1591 if (internetVpnId != null) {
1592 rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1594 Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1595 rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1597 if (rtrList.isEmpty()) {
1600 for (Uuid rtrId: rtrList) {
1601 Router router = getNeutronRouter(rtrId);
1602 ExternalGatewayInfo info = router.getExternalGatewayInfo();
1604 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1605 router.getUuid().getValue());
1608 // check that router really has given provider network as its external gateway port
1609 if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1610 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1611 router.getUuid().getValue(), extNet.getUuid().getValue());
1614 subList.addAll(getNeutronRouterSubnetIds(rtrId));
1619 public void updateVpnInstanceWithFallback(Uuid routerId, Uuid vpnName, boolean add) {
1620 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1621 if (vpnInstanceOpDataEntry == null) {
1622 LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1625 Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId().toJava();
1626 List<Uuid> routerIds = new ArrayList<>();
1627 //Handle router specific V6 internet fallback flow else handle all V6 external routers
1628 if (routerId != null) {
1629 routerIds.add(routerId);
1631 //This block will execute for ext-nw to Internet VPN association/disassociation event.
1632 routerIds = getRouterIdListforVpn(vpnName);
1634 if (routerIds == null || routerIds.isEmpty()) {
1635 LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1638 for (Uuid rtrId: routerIds) {
1639 if (rtrId == null) {
1642 List<Uint64> dpnIds = getDpnsForRouter(rtrId.getValue());
1643 if (dpnIds.isEmpty()) {
1646 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1647 Long routerIdAsLong = vpnOpDataEntry.getVpnId().toJava();
1649 Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1650 if (rtrVpnId == null) {
1651 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1652 vpnId = routerIdAsLong;
1654 vpnId = getVpnId(rtrVpnId.getValue());
1656 for (Uint64 dpnId : dpnIds) {
1658 LoggingFutures.addErrorLogging(
1659 txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
1660 tx -> ipV6InternetDefRt.installDefaultRoute(tx, dpnId, rtrId.getValue(),
1661 internetBgpVpnId, vpnId)), LOG, "Error adding default route");
1663 LoggingFutures.addErrorLogging(
1664 txRunner.callWithNewReadWriteTransactionAndSubmit(Datastore.CONFIGURATION,
1665 tx -> ipV6InternetDefRt.removeDefaultRoute(tx, dpnId, rtrId.getValue(),
1666 internetBgpVpnId, vpnId)), LOG,
1667 "Error removing default route");
1673 public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @NonNull Uuid vpn) {
1674 String primaryRd = getVpnRd(vpn.getValue());
1675 if (primaryRd == null) {
1676 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1677 + "Primary RD not found", choice, vpn.getValue());
1680 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1682 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1683 read(LogicalDatastoreType.OPERATIONAL, id);
1684 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1685 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1686 + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1689 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1690 if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1691 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1692 + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1695 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1696 builder.setBgpvpnType(choice);
1697 LoggingFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1698 tx.merge(id, builder.build());
1699 LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1700 }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1703 public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1704 return new RouterIdsBuilder().setRouterId(routerId).build();
1707 public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1708 List<RouterIds> listRouterIds = new ArrayList<>();
1709 for (Uuid routerId : routerIds) {
1710 final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1711 listRouterIds.add(routerIdInstance);
1713 return listRouterIds;
1717 public List<Uint64> getDpnsForRouter(String routerUuid) {
1718 InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1719 .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1720 Optional<RouterDpnList> routerDpnListData =
1721 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1722 LogicalDatastoreType.OPERATIONAL, id);
1723 List<Uint64> dpns = new ArrayList<>();
1724 if (routerDpnListData.isPresent()) {
1725 for (DpnVpninterfacesList dpnVpnInterface
1726 : routerDpnListData.get().nonnullDpnVpninterfacesList().values()) {
1727 dpns.add(dpnVpnInterface.getDpnId());
1734 List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1735 List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1736 if (subnetIdList != null) {
1737 List<Subnetmap> subnetmapList = new ArrayList<>();
1738 for (Uuid subnetId : subnetIdList) {
1739 Subnetmap subnetmap = getSubnetmap(subnetId);
1740 if (subnetmap != null) {
1741 subnetmapList.add(subnetmap);
1743 LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1744 subnetId.getValue(), networkId.getValue());
1747 return subnetmapList;
1749 LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1750 networkId.getValue());
1755 public long getVpnId(String vpnName) {
1756 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1757 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1758 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1759 LogicalDatastoreType.CONFIGURATION, id).map(
1760 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1761 .VpnInstance::getVpnId).orElse(null).toJava();
1764 protected boolean isV6SubnetPartOfRouter(Uuid routerId) {
1765 List<Subnetmap> subnetList = getNeutronRouterSubnetMapList(routerId);
1766 for (Subnetmap sm : subnetList) {
1770 IpVersionChoice ipVers = getIpVersionFromString(sm.getSubnetIp());
1771 //skip further subnet processing once found first V6 subnet for the router
1772 if (ipVers.isIpVersionChosen(IpVersionChoice.IPV6)) {
1779 @SuppressWarnings({ "unchecked", "rawtypes" })
1780 public <T extends DataObject> void asyncReadAndExecute(final LogicalDatastoreType datastoreType,
1781 final InstanceIdentifier<T> iid, final String jobKey,
1782 final Function<Optional<T>, Void> function) {
1783 jobCoordinator.enqueueJob(jobKey, () -> {
1784 SettableFuture<Optional<T>> settableFuture = SettableFuture.create();
1785 List futures = Collections.singletonList(settableFuture);
1786 try (ReadTransaction tx = dataBroker.newReadOnlyTransaction()) {
1787 Futures.addCallback(tx.read(datastoreType, iid),
1788 new SettableFutureCallback<Optional<T>>(settableFuture) {
1790 public void onSuccess(Optional<T> data) {
1791 function.apply(data);
1792 super.onSuccess(data);
1794 }, MoreExecutors.directExecutor());
1798 }, JOB_MAX_RETRIES);
1801 private static InstanceIdentifier<VpnMap> vpnMapIdentifier(Uuid uuid) {
1802 return VPN_MAPS_IID.child(VpnMap.class, new VpnMapKey(uuid));
1805 private class SettableFutureCallback<T> implements FutureCallback<T> {
1807 private final SettableFuture<T> settableFuture;
1809 SettableFutureCallback(SettableFuture<T> settableFuture) {
1810 this.settableFuture = settableFuture;
1814 public void onSuccess(T objT) {
1815 settableFuture.set(objT);
1819 public void onFailure(Throwable throwable) {
1820 settableFuture.setException(throwable);