2 * Copyright (c) 2016, 2018 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.netvirt.neutronvpn;
11 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
13 import com.google.common.base.Optional;
14 import com.google.common.collect.ImmutableBiMap;
15 import com.google.common.collect.Sets;
16 import java.math.BigInteger;
17 import java.net.Inet4Address;
18 import java.net.Inet6Address;
19 import java.net.InetAddress;
20 import java.net.UnknownHostException;
21 import java.util.ArrayList;
22 import java.util.Collection;
23 import java.util.Collections;
24 import java.util.HashMap;
25 import java.util.HashSet;
26 import java.util.Iterator;
27 import java.util.List;
30 import java.util.concurrent.ConcurrentHashMap;
31 import java.util.concurrent.ConcurrentMap;
32 import java.util.concurrent.ExecutionException;
33 import java.util.concurrent.Future;
34 import java.util.stream.Collectors;
35 import javax.annotation.Nonnull;
36 import javax.inject.Inject;
37 import javax.inject.Singleton;
38 import org.apache.commons.lang3.StringUtils;
39 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
40 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
41 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
42 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
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.infrautils.jobcoordinator.JobCoordinator;
50 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
51 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
52 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
53 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
54 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
55 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
56 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
58 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.PortSubnets;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnet;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetKey;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfo;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoBuilder;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoKey;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
158 import org.opendaylight.yangtools.yang.binding.DataObject;
159 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
160 import org.opendaylight.yangtools.yang.common.RpcResult;
161 import org.slf4j.Logger;
162 import org.slf4j.LoggerFactory;
165 public class NeutronvpnUtils {
167 private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
168 private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
170 new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
171 .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
172 .put(NetworkTypeGre.class, SegmentTypeGre.class)
173 .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
174 .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
177 private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
180 SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
181 SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
182 SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
183 SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
186 private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
187 private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
188 private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
189 private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
190 private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
191 private final ConcurrentMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
192 private final ConcurrentMap<Uuid, HashMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
193 private final ConcurrentMap<Uuid, HashMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
195 private final DataBroker dataBroker;
196 private final ManagedNewTransactionRunner txRunner;
197 private final IdManagerService idManager;
198 private final JobCoordinator jobCoordinator;
199 private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
202 public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
203 final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
204 this.dataBroker = dataBroker;
205 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
206 this.idManager = idManager;
207 this.jobCoordinator = jobCoordinator;
208 this.ipV6InternetDefRt = ipV6InternetDefRt;
211 protected Subnetmap getSubnetmap(Uuid subnetId) {
212 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
213 Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
215 if (sn.isPresent()) {
218 LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
222 public VpnMap getVpnMap(Uuid id) {
223 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
224 new VpnMapKey(id)).build();
225 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
226 if (optionalVpnMap.isPresent()) {
227 return optionalVpnMap.get();
229 LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
233 protected Uuid getVpnForNetwork(Uuid network) {
234 InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
235 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
236 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
237 List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
238 for (VpnMap vpnMap : allMaps) {
239 List<Uuid> netIds = vpnMap.getNetworkIds();
240 if (netIds != null && netIds.contains(network)) {
241 return vpnMap.getVpnId();
245 LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
249 protected Uuid getVpnForSubnet(Uuid subnetId) {
250 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
251 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
252 subnetmapIdentifier);
253 if (optionalSubnetMap.isPresent()) {
254 return optionalSubnetMap.get().getVpnId();
256 LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
260 protected Uuid getNetworkForSubnet(Uuid subnetId) {
261 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
262 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
263 subnetmapIdentifier);
264 if (optionalSubnetMap.isPresent()) {
265 return optionalSubnetMap.get().getNetworkId();
267 LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
271 // @param external vpn - true if external vpn being fetched, false for internal vpn
272 protected Uuid getVpnForRouter(Uuid routerId, boolean externalVpn) {
273 if (routerId == null) {
277 InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
278 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
279 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
280 List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
281 for (VpnMap vpnMap : allMaps) {
282 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
283 .RouterIds> routerIdsList = vpnMap.getRouterIds();
284 if (routerIdsList == null || routerIdsList.isEmpty()) {
287 boolean isInternetBgpVpn = false;
288 //Skip router vpnId fetching from internet BGP-VPN
289 if (vpnMap.getNetworkIds() != null && !vpnMap.getNetworkIds().isEmpty()) {
290 for (Uuid netId: vpnMap.getNetworkIds()) {
291 Network network = getNeutronNetwork(netId);
292 if (getIsExternal(network)) {
293 isInternetBgpVpn = true;
295 /* If first network is not a external network then no need iterate
296 * whole network list from the VPN
301 if (isInternetBgpVpn) {
302 //skip further processing
305 List<Uuid> rtrIdsList = routerIdsList.stream().map(routerIds -> routerIds.getRouterId())
306 .collect(Collectors.toList());
307 if (rtrIdsList.contains(routerId)) {
309 if (!routerId.equals(vpnMap.getVpnId())) {
310 return vpnMap.getVpnId();
313 if (routerId.equals(vpnMap.getVpnId())) {
314 return vpnMap.getVpnId();
320 LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
324 protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
325 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
326 new VpnMapKey(vpnId)).build();
327 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
328 if (optionalVpnMap.isPresent()) {
329 VpnMap vpnMap = optionalVpnMap.get();
330 return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
332 LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
336 protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
337 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
338 new VpnMapKey(vpnId)).build();
339 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
340 if (optionalVpnMap.isPresent()) {
341 VpnMap vpnMap = optionalVpnMap.get();
342 return vpnMap.getNetworkIds();
344 LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
348 protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
349 List<Uuid> subnets = new ArrayList<>();
351 InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
352 Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
353 if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
354 List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
355 for (Subnetmap candidateSubnetMap : subnetMapList) {
356 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
357 subnets.add(candidateSubnetMap.getId());
364 protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
365 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
366 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
367 if (vpnPortipToPortData.isPresent()) {
368 return vpnPortipToPortData.get().getPortName();
370 LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
371 + " fixed IP {}", vpnName, fixedIp);
375 protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
376 InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
377 Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
378 if (optionalNetworkMap.isPresent()) {
379 return optionalNetworkMap.get().getSubnetIdList();
381 LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
385 protected List<Uuid> getPortIdsFromSubnetId(Uuid subnetId) {
386 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
387 Optional<Subnetmap> optionalSubnetmap = read(LogicalDatastoreType.CONFIGURATION, id);
388 if (optionalSubnetmap.isPresent()) {
389 return optionalSubnetmap.get().getPortList();
394 protected Router getNeutronRouter(Uuid routerId) {
395 Router router = routerMap.get(routerId);
396 if (router != null) {
399 InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
400 .class, new RouterKey(routerId));
401 Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
402 if (rtr.isPresent()) {
408 public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
409 return InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
410 .class, new RouterKey(routerId));
414 protected Network getNeutronNetwork(Uuid networkId) {
415 Network network = null;
416 network = networkMap.get(networkId);
417 if (network != null) {
420 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
421 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
422 .child(Network.class, new NetworkKey(networkId));
423 Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
424 if (net.isPresent()) {
430 protected Port getNeutronPort(Uuid portId) {
431 Port prt = portMap.get(portId);
435 LOG.debug("getNeutronPort for {}", portId.getValue());
436 InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
437 new PortKey(portId));
438 Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
439 if (port.isPresent()) {
446 * Returns port_security_enabled status with the port.
448 * @param port the port
449 * @return port_security_enabled status
451 protected static boolean getPortSecurityEnabled(Port port) {
452 String deviceOwner = port.getDeviceOwner();
453 if (deviceOwner != null && deviceOwner.startsWith("network:")) {
454 // port with device owner of network:xxx is created by
455 // neutorn for its internal use. So security group doesn't apply.
456 // router interface, dhcp port and floating ip.
459 PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
460 if (portSecurity != null) {
461 return portSecurity.isPortSecurityEnabled();
467 * Gets security group UUIDs delta .
469 * @param port1SecurityGroups the port 1 security groups
470 * @param port2SecurityGroups the port 2 security groups
471 * @return the security groups delta
473 protected static List<Uuid> getSecurityGroupsDelta(List<Uuid> port1SecurityGroups,
474 List<Uuid> port2SecurityGroups) {
475 if (port1SecurityGroups == null) {
479 if (port2SecurityGroups == null) {
480 return port1SecurityGroups;
483 List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
484 List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
485 for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
486 Uuid securityGroup1 = iterator.next();
487 for (Uuid securityGroup2 : list2) {
488 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
498 * Gets the fixed ips delta.
500 * @param port1FixedIps the port 1 fixed ips
501 * @param port2FixedIps the port 2 fixed ips
502 * @return the fixed ips delta
504 protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
505 if (port1FixedIps == null) {
509 if (port2FixedIps == null) {
510 return port1FixedIps;
513 List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
514 List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
515 for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
516 FixedIps fixedIps1 = iterator.next();
517 for (FixedIps fixedIps2 : list2) {
518 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
528 * Gets the allowed address pairs delta.
530 * @param port1AllowedAddressPairs the port 1 allowed address pairs
531 * @param port2AllowedAddressPairs the port 2 allowed address pairs
532 * @return the allowed address pairs delta
534 protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
535 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
536 .AllowedAddressPairs> port1AllowedAddressPairs,
537 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
538 .AllowedAddressPairs> port2AllowedAddressPairs) {
539 if (port1AllowedAddressPairs == null) {
543 if (port2AllowedAddressPairs == null) {
544 return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
547 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
548 .AllowedAddressPairs> list1 =
549 new ArrayList<>(port1AllowedAddressPairs);
550 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
551 .AllowedAddressPairs> list2 =
552 new ArrayList<>(port2AllowedAddressPairs);
553 for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
554 .AllowedAddressPairs> iterator =
555 list1.iterator(); iterator.hasNext();) {
556 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
557 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
558 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
559 .AllowedAddressPairs allowedAddressPair2 : list2) {
560 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
566 return getAllowedAddressPairsForAclService(list1);
570 * Gets the acl allowed address pairs.
572 * @param macAddress the mac address
573 * @param ipAddress the ip address
574 * @return the acl allowed address pairs
576 protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
577 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
578 AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
579 aclAllowedAdressPairBuilder.setMacAddress(macAddress);
580 if (ipAddress != null && ipAddress.stringValue() != null) {
581 if (ipAddress.getIpPrefix() != null) {
582 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
584 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
587 return aclAllowedAdressPairBuilder.build();
591 * Gets the allowed address pairs for acl service.
593 * @param macAddress the mac address
594 * @param fixedIps the fixed ips
595 * @return the allowed address pairs for acl service
597 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
598 List<FixedIps> fixedIps) {
599 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
600 for (FixedIps fixedIp : fixedIps) {
601 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
602 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
603 .getDefaultInstance(fixedIp.getIpAddress().stringValue())));
605 return aclAllowedAddressPairs;
609 * Gets the allowed address pairs for acl service.
611 * @param portAllowedAddressPairs the port allowed address pairs
612 * @return the allowed address pairs for acl service
614 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
615 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
616 .AllowedAddressPairs> portAllowedAddressPairs) {
617 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
618 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
619 portAllowedAddressPair : portAllowedAddressPairs) {
620 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
621 portAllowedAddressPair.getIpAddress()));
623 return aclAllowedAddressPairs;
627 * Gets the IPv6 Link Local Address corresponding to the MAC Address.
629 * @param macAddress the mac address
630 * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
632 protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
633 IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
634 return getAclAllowedAddressPairs(macAddress,
635 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddressBuilder
637 ipv6LinkLocalAddress.stringValue()));
641 * Gets the updated security groups.
643 * @param aclInterfaceSecurityGroups the acl interface security groups
644 * @param origSecurityGroups the orig security groups
645 * @param newSecurityGroups the new security groups
646 * @return the updated security groups
648 protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
649 List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
650 List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
651 List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
652 List<Uuid> updatedSecurityGroups =
653 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
654 if (addedGroups != null) {
655 updatedSecurityGroups.addAll(addedGroups);
657 if (deletedGroups != null) {
658 updatedSecurityGroups.removeAll(deletedGroups);
660 return updatedSecurityGroups;
664 * Gets the allowed address pairs for fixed ips.
666 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
667 * @param portMacAddress the port mac address
668 * @param origFixedIps the orig fixed ips
669 * @param newFixedIps the new fixed ips
670 * @return the allowed address pairs for fixed ips
672 protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
673 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
674 List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
675 List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
676 List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
677 List<AllowedAddressPairs> updatedAllowedAddressPairs =
678 aclInterfaceAllowedAddressPairs != null
679 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
680 if (deletedFixedIps != null) {
681 updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
683 if (addedFixedIps != null) {
684 updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
686 return updatedAllowedAddressPairs;
690 * Gets the updated allowed address pairs.
692 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
693 * @param origAllowedAddressPairs the orig allowed address pairs
694 * @param newAllowedAddressPairs the new allowed address pairs
695 * @return the updated allowed address pairs
697 protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
698 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
699 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
700 .AllowedAddressPairs> origAllowedAddressPairs,
701 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
702 .AllowedAddressPairs> newAllowedAddressPairs) {
703 List<AllowedAddressPairs> addedAllowedAddressPairs =
704 getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
705 List<AllowedAddressPairs> deletedAllowedAddressPairs =
706 getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
707 List<AllowedAddressPairs> updatedAllowedAddressPairs =
708 aclInterfaceAllowedAddressPairs != null
709 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
710 if (addedAllowedAddressPairs != null) {
711 updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
713 if (deletedAllowedAddressPairs != null) {
714 updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
716 return updatedAllowedAddressPairs;
720 * Populate interface acl builder.
722 * @param interfaceAclBuilder the interface acl builder
723 * @param port the port
725 protected static void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
726 // Handle security group enabled
727 List<Uuid> securityGroups = port.getSecurityGroups();
728 if (securityGroups != null) {
729 interfaceAclBuilder.setSecurityGroups(securityGroups);
731 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
732 port.getMacAddress(), port.getFixedIps());
733 // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
734 aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
735 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
736 portAllowedAddressPairs = port.getAllowedAddressPairs();
737 if (portAllowedAddressPairs != null) {
738 aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
740 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
743 protected void populateSubnetInfo(Port port) {
744 List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
745 if (portSubnetInfo != null) {
746 String portId = port.getUuid().getValue();
747 InstanceIdentifier<PortSubnet> portSubnetIdentifier = buildPortSubnetIdentifier(portId);
749 PortSubnetBuilder portSubnetBuilder = new PortSubnetBuilder().withKey(new PortSubnetKey(portId))
750 .setPortId(portId).setSubnetInfo(portSubnetInfo);
752 SingleTransactionDataBroker.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
753 portSubnetIdentifier, portSubnetBuilder.build());
754 } catch (TransactionCommitFailedException e) {
755 LOG.error("Failed to populate subnet info for port={}", portId, e);
757 LOG.debug("Created Subnet info for port={}", portId);
761 protected List<SubnetInfo> getSubnetInfo(Port port) {
762 List<FixedIps> portFixedIps = port.getFixedIps();
763 if (portFixedIps == null) {
764 LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
767 List<SubnetInfo> subnetInfoList = new ArrayList<>();
768 for (FixedIps portFixedIp : portFixedIps) {
769 Uuid subnetId = portFixedIp.getSubnetId();
770 Subnet subnet = getNeutronSubnet(subnetId);
771 if (subnet != null) {
772 Class<? extends IpVersionBase> ipVersion =
773 NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
774 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
775 : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
776 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
777 .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
778 .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
779 subnetInfoList.add(subnetInfo);
782 return subnetInfoList;
785 protected Subnet getNeutronSubnet(Uuid subnetId) {
786 Subnet subnet = subnetMap.get(subnetId);
787 if (subnet != null) {
790 InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
791 .class, new SubnetKey(subnetId));
792 Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
794 if (sn.isPresent()) {
796 addToSubnetCache(subnet);
801 protected List<Subnetmap> getNeutronRouterSubnetMapList(Uuid routerId) {
802 List<Subnetmap> subnetMapList = new ArrayList<>();
803 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
804 InstanceIdentifier.builder(Subnetmaps.class).build());
805 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
806 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
807 if (routerId.equals(subnetmap.getRouterId())) {
808 subnetMapList.add(subnetmap);
812 LOG.debug("getNeutronRouterSubnetMapList returns {}", subnetMapList);
813 return subnetMapList;
817 protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
818 LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
819 List<Uuid> subnetIdList = new ArrayList<>();
820 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
821 InstanceIdentifier.builder(Subnetmaps.class).build());
822 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
823 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
824 if (routerId.equals(subnetmap.getRouterId())) {
825 subnetIdList.add(subnetmap.getId());
829 LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
833 // TODO Clean up the exception handling and the console output
834 @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
835 protected Short getIPPrefixFromPort(Port port) {
837 Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
838 SubnetKey subnetkey = new SubnetKey(subnetUUID);
839 InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
840 .class).child(Subnet.class, subnetkey);
841 Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
842 if (subnet.isPresent()) {
843 String cidr = subnet.get().getCidr().stringValue();
844 // Extract the prefix length from cidr
845 String[] parts = cidr.split("/");
846 if (parts.length == 2) {
847 return Short.valueOf(parts[1]);
849 LOG.trace("Could not retrieve prefix from subnet CIDR");
852 LOG.trace("Unable to read on subnet datastore");
854 } catch (Exception e) {
855 LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
857 LOG.error("Failed for port {}", port.getUuid().getValue());
861 // TODO Clean up the exception handling
862 @SuppressWarnings("checkstyle:IllegalCatch")
863 protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
864 boolean isSubnetIp, TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
865 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
866 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
867 .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
868 .setVpnName(vpnName).setPortFixedip(fixedIp)
869 .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
871 if (writeConfigTxn != null) {
872 writeConfigTxn.put(id, builder.build());
874 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
876 LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
877 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
878 } catch (Exception e) {
879 LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
884 // TODO Clean up the exception handling
885 @SuppressWarnings("checkstyle:IllegalCatch")
886 protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp,
887 TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
888 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
890 if (writeConfigTxn != null) {
891 writeConfigTxn.delete(id);
893 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
895 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
897 } catch (Exception e) {
898 LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
903 // TODO Clean up the exception handling
904 @SuppressWarnings("checkstyle:IllegalCatch")
905 protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
906 InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
908 synchronized ((vpnName + fixedIp).intern()) {
909 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
911 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
913 } catch (Exception e) {
914 LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
915 vpnName, fixedIp, e);
919 public void addToNetworkCache(Network network) {
920 networkMap.put(network.getUuid(), network);
923 public void removeFromNetworkCache(Network network) {
924 networkMap.remove(network.getUuid());
927 public void addToRouterCache(Router router) {
928 routerMap.put(router.getUuid(), router);
931 public void removeFromRouterCache(Router router) {
932 routerMap.remove(router.getUuid());
935 public Collection<Router> getAllRouters() {
936 return routerMap.values();
939 public void addToPortCache(Port port) {
940 portMap.put(port.getUuid(), port);
943 public void removeFromPortCache(Port port) {
944 portMap.remove(port.getUuid());
947 public void addToSubnetCache(Subnet subnet) {
948 subnetMap.put(subnet.getUuid(), subnet);
949 IpAddress gatewayIp = subnet.getGatewayIp();
950 if (gatewayIp != null) {
951 subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
955 public void removeFromSubnetCache(Subnet subnet) {
956 subnetMap.remove(subnet.getUuid());
957 IpAddress gatewayIp = subnet.getGatewayIp();
958 if (gatewayIp != null) {
959 Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
961 gwIps.remove(subnet.getUuid());
966 public static String getSegmentationIdFromNeutronNetwork(Network network) {
967 String segmentationId = null;
968 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
969 if (providerExtension != null) {
970 Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
971 segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
974 return segmentationId;
977 public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
978 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
979 return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
982 public static String getPhysicalNetworkName(Network network) {
983 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
984 return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
987 public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
988 return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
991 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
992 InstanceIdentifier<VpnPortipToPort> id =
993 InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
994 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
998 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
999 InstanceIdentifier<LearntVpnVipToPort> id =
1000 InstanceIdentifier.builder(LearntVpnVipToPortData.class)
1001 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
1005 static Boolean getIsExternal(Network network) {
1006 return network.augmentation(NetworkL3Extension.class) != null
1007 && network.augmentation(NetworkL3Extension.class).isExternal();
1010 public void addToQosPolicyCache(QosPolicy qosPolicy) {
1011 qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
1014 public void removeFromQosPolicyCache(QosPolicy qosPolicy) {
1015 qosPolicyMap.remove(qosPolicy.getUuid());
1018 public void addToQosPortsCache(Uuid qosUuid, Port port) {
1019 if (qosPortsMap.containsKey(qosUuid)) {
1020 if (!qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
1021 qosPortsMap.get(qosUuid).put(port.getUuid(), port);
1024 HashMap<Uuid, Port> newPortMap = new HashMap<>();
1025 newPortMap.put(port.getUuid(), port);
1026 qosPortsMap.put(qosUuid, newPortMap);
1030 public void removeFromQosPortsCache(Uuid qosUuid, Port port) {
1031 if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
1032 qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
1036 public void addToQosNetworksCache(Uuid qosUuid, Network network) {
1037 if (qosNetworksMap.containsKey(qosUuid)) {
1038 if (!qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
1039 qosNetworksMap.get(qosUuid).put(network.getUuid(), network);
1042 HashMap<Uuid, Network> newNetworkMap = new HashMap<>();
1043 newNetworkMap.put(network.getUuid(), network);
1044 qosNetworksMap.put(qosUuid, newNetworkMap);
1048 public void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
1049 if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
1050 qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
1054 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1055 InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1056 NetworkMapKey(networkId)).build();
1060 static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1061 InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1062 .class, new VpnInterfaceKey(ifName)).build();
1066 static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1067 InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
1068 SubnetmapKey(subnetId)).build();
1072 static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1073 InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1074 InterfaceKey(interfaceName)).build();
1078 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1079 .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1080 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1081 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1082 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1083 .getValue())).build();
1087 static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1088 return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1089 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1092 static InstanceIdentifier<PortSubnet> buildPortSubnetIdentifier(String portId) {
1093 InstanceIdentifier<PortSubnet> id = InstanceIdentifier.builder(PortSubnets.class)
1094 .child(PortSubnet.class, new PortSubnetKey(portId)).build();
1098 // TODO Remove this method entirely
1099 @SuppressWarnings("checkstyle:IllegalCatch")
1100 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1102 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1103 } catch (ReadFailedException e) {
1104 throw new RuntimeException(e);
1108 public static Class<? extends NetworkTypeBase> getNetworkType(Network network) {
1109 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
1110 return providerExtension != null ? providerExtension.getNetworkType() : null;
1113 static ProviderTypes getProviderNetworkType(Network network) {
1114 if (network == null) {
1115 LOG.error("Error in getting provider network type since network is null");
1118 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1120 Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1121 if (networkTypeBase != null) {
1122 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1123 return ProviderTypes.FLAT;
1124 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1125 return ProviderTypes.VLAN;
1126 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1127 return ProviderTypes.VXLAN;
1128 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1129 return ProviderTypes.GRE;
1133 LOG.error("Error in getting provider network type since network provider extension is null for network "
1134 + "{}", network.getUuid().getValue());
1138 static boolean isNetworkTypeSupported(Network network) {
1139 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1140 return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1143 static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1144 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1145 if (npe != null && npe.getNetworkType() != null) {
1146 return type.isAssignableFrom(npe.getNetworkType());
1151 static boolean isFlatOrVlanNetwork(Network network) {
1152 return network != null
1153 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1156 static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1157 return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1161 * Get inter-VPN link state.
1163 * @param vpnLinkName VPN link name
1164 * @return Optional of InterVpnLinkState
1166 public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1167 InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1168 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1169 return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1173 * Returns an InterVpnLink by searching by one of its endpoint's IP.
1175 * @param endpointIp IP to search for
1176 * @return a InterVpnLink
1178 public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1179 InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1180 Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1182 if (interVpnLinksOpData.isPresent()) {
1183 List<InterVpnLink> allInterVpnLinks = interVpnLinksOpData.get().getInterVpnLink();
1184 for (InterVpnLink interVpnLink : allInterVpnLinks) {
1185 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1186 || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1187 return Optional.of(interVpnLink);
1191 return Optional.absent();
1194 public Set<RouterDpnList> getAllRouterDpnList(BigInteger dpid) {
1195 Set<RouterDpnList> ret = new HashSet<>();
1196 InstanceIdentifier<NeutronRouterDpns> routerDpnId =
1197 InstanceIdentifier.create(NeutronRouterDpns.class);
1198 Optional<NeutronRouterDpns> neutronRouterDpnsOpt =
1199 MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, routerDpnId);
1200 if (neutronRouterDpnsOpt.isPresent()) {
1201 NeutronRouterDpns neutronRouterDpns = neutronRouterDpnsOpt.get();
1202 List<RouterDpnList> routerDpnLists = neutronRouterDpns.getRouterDpnList();
1203 for (RouterDpnList routerDpnList : routerDpnLists) {
1204 if (routerDpnList.getDpnVpninterfacesList() != null) {
1205 for (DpnVpninterfacesList dpnInterfaceList : routerDpnList.getDpnVpninterfacesList()) {
1206 if (dpnInterfaceList.getDpnId().equals(dpid)) {
1207 ret.add(routerDpnList);
1216 protected Integer getUniqueRDId(String poolName, String idKey) {
1217 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1219 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
1220 RpcResult<AllocateIdOutput> rpcResult = result.get();
1221 if (rpcResult.isSuccessful()) {
1222 return rpcResult.getResult().getIdValue().intValue();
1224 LOG.error("RPC call to get unique ID for pool name {} with ID key {} returned with errors {}",
1225 poolName, idKey, rpcResult.getErrors());
1227 } catch (InterruptedException | ExecutionException e) {
1228 LOG.error("Exception when getting Unique Id for poolname {} and ID Key {}", poolName, idKey, e);
1230 LOG.error("getUniqueRdId: Failed to return ID for poolname {} and ID Key {}", poolName, idKey);
1234 protected void releaseRDId(String poolName, String idKey) {
1235 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1237 RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
1238 if (!rpcResult.isSuccessful()) {
1239 LOG.error("RPC Call to Get Unique Id returned with errors for poolname {} and ID Key {}: {}",
1240 poolName, idKey, rpcResult.getErrors());
1242 LOG.info("ID {} for RD released successfully", idKey);
1244 } catch (InterruptedException | ExecutionException e) {
1245 LOG.error("Exception when trying to release ID for poolname {} and ID Key {}", poolName, idKey, e);
1249 protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1250 byte[] octets = bytesFromHexString(mac.getValue());
1252 /* As per the RFC2373, steps involved to generate a LLA include
1253 1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1254 between OUI and NIC Specific part.
1255 2. Invert the Universal/Local flag in the OUI portion of the address.
1256 3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1257 identifier to generate the IPv6 LLA. */
1259 StringBuilder interfaceID = new StringBuilder();
1260 short u8byte = (short) (octets[0] & 0xff);
1262 interfaceID.append(Integer.toHexString(0xFF & u8byte));
1263 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1264 interfaceID.append(":");
1265 interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1266 interfaceID.append("ff:fe");
1267 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1268 interfaceID.append(":");
1269 interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1270 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1272 Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1273 IpAddress ipAddress = new IpAddress(ipv6LLA);
1277 protected static byte[] bytesFromHexString(String values) {
1279 if (values != null) {
1282 String[] octets = target.split(":");
1284 byte[] ret = new byte[octets.length];
1285 for (int i = 0; i < octets.length; i++) {
1286 ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1291 public List<String> getExistingRDs() {
1292 List<String> existingRDs = new ArrayList<>();
1293 InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1294 Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1295 if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1296 for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1297 if (vpnInstance.getIpv4Family() == null) {
1300 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1302 existingRDs.addAll(rds);
1309 protected boolean doesVpnExist(Uuid vpnId) {
1310 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
1311 new VpnMapKey(vpnId)).build();
1312 return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier).isPresent();
1315 protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1316 .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1317 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1318 .rev160111.external.subnets.Subnets> subnetsIdentifier =
1319 InstanceIdentifier.builder(ExternalSubnets.class)
1320 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1321 .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1322 return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1325 public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1326 PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1327 List<FixedIps> fixedIps = port.getFixedIps();
1328 IpAddress ipAddress = null;
1329 if (isNotEmpty(fixedIps)) {
1330 ipAddress = port.getFixedIps().get(0).getIpAddress();
1332 StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1333 List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1334 if (ipAddress != null) {
1335 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1337 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1339 return staticMacEntries;
1342 public static boolean isEmpty(Collection<?> collection) {
1343 return collection == null || collection.isEmpty();
1346 public static boolean isNotEmpty(Collection<?> collection) {
1347 return !isEmpty(collection);
1351 * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1352 * @param routerUuid the Uuid for which find out the IP version associated
1353 * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1355 public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1356 IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1357 if (routerUuid == null) {
1360 List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1361 if (subnetmapList.isEmpty()) {
1364 for (Subnetmap sn : subnetmapList) {
1365 if (sn.getSubnetIp() != null) {
1366 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1367 if (rep.choice != ipVers.choice) {
1368 rep = rep.addVersion(ipVers);
1370 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1378 /**This method return the list of Subnetmap associated to the router or a empty list if any.
1379 * @param routerId the Uuid of router for which subnetmap is find out
1380 * @return a list of Subnetmap associated to the router. it could be empty if any
1382 protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1383 List<Subnetmap> subnetIdList = new ArrayList<>();
1384 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
1385 InstanceIdentifier.builder(Subnetmaps.class).build());
1386 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1387 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1388 if (routerId.equals(subnetmap.getRouterId())) {
1389 subnetIdList.add(subnetmap);
1393 return subnetIdList;
1396 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1397 .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1398 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1399 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1400 .instance.to.vpn.id.VpnInstance.class,
1401 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1402 .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1406 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1407 * @param vpnName Name of the VPN
1409 * @return the route-distinguisher of the VPN
1411 public String getVpnRd(String vpnName) {
1412 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1413 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1414 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1415 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1416 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1417 .VpnInstance::getVrfId).orElse(null);
1420 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1421 * @param ipAddress String of an representation IP address V4 or V6
1422 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1424 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1425 IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1426 if (ipAddress.contains("/")) {
1427 ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1430 InetAddress address = InetAddress.getByName(ipAddress);
1431 if (address instanceof Inet4Address) {
1432 return IpVersionChoice.IPV4;
1433 } else if (address instanceof Inet6Address) {
1434 return IpVersionChoice.IPV6;
1436 } catch (UnknownHostException | SecurityException e) {
1437 LOG.error("getIpVersionFromString: could not find version for {}", ipAddress);
1442 /**Get IpVersionChoice from Uuid Subnet.
1443 * @param sm Subnetmap structure
1444 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1446 public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1447 if (sm != null && sm.getSubnetIp() != null) {
1448 return getIpVersionFromString(sm.getSubnetIp());
1450 return IpVersionChoice.UNDEFINED;
1453 public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1454 String primaryRd = getVpnRd(vpnName);
1455 if (primaryRd == null) {
1456 LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1457 + "Primary RD not found", vpnName);
1460 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1461 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1462 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1463 LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1466 return vpnInstanceOpDataEntryOptional.get();
1469 protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1470 return InstanceIdentifier.builder(VpnInstanceOpData.class)
1471 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1474 public boolean shouldVpnHandleIpVersionChoiceChange(IpVersionChoice ipVersion, Uuid routerId, boolean add) {
1475 int subnetCount = -1;
1476 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1477 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1478 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1479 subnetCount = getSubnetCountFromRouter(routerId, ipVersion);
1481 //Possible value of ipversion choice is either V4 or V6 only. Not accepted V4andV6 and Undefined
1484 /* ADD: Update vpnInstanceOpDataEntry with address family only on first IPv4/IPv6 subnet
1485 * for the VPN Instance.
1487 * REMOVE: Update vpnInstanceOpDataEntry with address family only on last IPv4/IPv6 subnet
1488 * for the VPN Instance.
1490 if (add && subnetCount == 1) {
1492 } else if (!add && subnetCount == 0) {
1499 public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1503 InstanceIdentifier<Subnetmaps> subnetMapsId = InstanceIdentifier.builder(Subnetmaps.class).build();
1504 Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, subnetMapsId);
1505 // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1506 List<IpVersionChoice> snIpVersions = new ArrayList<>();
1507 for (Subnetmap snMap: allSubnetMaps.get().getSubnetmap()) {
1508 if (snMap.getId().equals(sm.getId())) {
1511 if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1512 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1514 if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1515 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1518 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1519 if (!snIpVersions.contains(ipVersion)) {
1525 public int getSubnetCountFromRouter(Uuid routerId, IpVersionChoice ipVer) {
1526 List<Subnetmap> subnetMapList = getNeutronRouterSubnetMapList(routerId);
1527 int subnetCount = 0;
1528 for (Subnetmap subMap : subnetMapList) {
1529 IpVersionChoice ipVersion = getIpVersionFromString(subMap.getSubnetIp());
1530 if (ipVersion.isIpVersionChosen(ipVer)) {
1533 if (subnetCount > 1) {
1540 public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1541 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1542 if (vpnInstanceOpDataEntry == null) {
1545 if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1546 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1547 + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName, ipVersion);
1550 if (ipVersion == IpVersionChoice.UNDEFINED) {
1551 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with Undefined address family"
1552 + "is not allowed. Do nothing", vpnName);
1555 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1556 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1557 boolean ipConfigured = add;
1558 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4AND6)) {
1559 builder.setIpv4Configured(ipConfigured);
1560 builder.setIpv6Configured(ipConfigured);
1561 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4)) {
1562 builder.setIpv4Configured(ipConfigured);
1563 } else if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6)) {
1564 builder.setIpv6Configured(ipConfigured);
1566 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1567 OPERATIONAL, tx -> {
1568 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
1569 .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
1570 new VpnInstanceOpDataEntryKey(vpnInstanceOpDataEntry.getVrfId())).build();
1571 tx.merge(id, builder.build(), false);
1572 LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1573 add == true ? "added" : "removed", ipVersion, vpnName);
1579 * Get the vpnInstance from its Uuid.
1581 * @param broker to get informations from ds
1582 * @param vpnId the Uuid of the VPN
1583 * @return the VpnInstance or null if unfindable
1585 public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1586 if (broker == null || vpnId == null) {
1589 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1590 new VpnInstanceKey(vpnId.getValue())).build();
1591 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1592 return vpnInstance.isPresent() ? vpnInstance.get() : null;
1596 *Get the Uuid of external network of the router (remember you that one router have only one external network).
1597 * @param routerId the Uuid of the router which you try to reach the external network
1598 * @return Uuid of externalNetwork or null if is not exist
1600 protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@Nonnull Uuid routerId) {
1601 LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1602 Uuid externalNetworkUuid = null;
1603 Router router = getNeutronRouter(routerId);
1604 if (router != null && router.getExternalGatewayInfo() != null) {
1605 externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1607 return externalNetworkUuid;
1610 public Uuid getInternetvpnUuidBoundToRouterId(@Nonnull Uuid routerId) {
1611 Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1612 if (netId == null) {
1615 return getVpnForNetwork(netId);
1619 * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1620 * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1621 * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1622 * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1623 * @return Uuid of externalVpn or null if it is not found
1625 public Uuid getInternetvpnUuidBoundToSubnetRouter(@Nonnull Uuid subnetUuid) {
1626 Subnetmap subnetmap = getSubnetmap(subnetUuid);
1627 Uuid routerUuid = subnetmap.getRouterId();
1628 LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1629 if (routerUuid == null) {
1632 Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1633 return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1637 * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1638 * @param extNet Provider Network, which has a port attached as external network gateway to router
1639 * @return a list of Private Subnetmap Ids of the router with external network gateway
1641 public @Nonnull List<Uuid> getPrivateSubnetsToExport(@Nonnull Network extNet, Uuid internetVpnId) {
1642 List<Uuid> subList = new ArrayList<>();
1643 List<Uuid> rtrList = new ArrayList<>();
1644 if (internetVpnId != null) {
1645 rtrList.addAll(getRouterIdListforVpn(internetVpnId));
1647 Uuid extNwVpnId = getVpnForNetwork(extNet.getUuid());
1648 rtrList.addAll(getRouterIdListforVpn(extNwVpnId));
1650 if (rtrList == null || rtrList.isEmpty()) {
1653 for (Uuid rtrId: rtrList) {
1654 Router router = getNeutronRouter(rtrId);
1655 ExternalGatewayInfo info = router.getExternalGatewayInfo();
1657 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1658 router.getUuid().getValue());
1661 // check that router really has given provider network as its external gateway port
1662 if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1663 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1664 router.getUuid().getValue(), extNet.getUuid().getValue());
1667 subList.addAll(getSubnetsforVpn(rtrId));
1672 public void updateVpnInstanceWithFallback(Uuid vpnName, boolean add) {
1673 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName.getValue());
1674 if (vpnInstanceOpDataEntry == null) {
1675 LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1678 Long internetBgpVpnId = vpnInstanceOpDataEntry.getVpnId();
1679 List<Uuid> routerIds = getRouterIdListforVpn(vpnName);
1680 if (routerIds == null || routerIds.isEmpty()) {
1681 LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1684 for (Uuid rtrId: routerIds) {
1685 if (rtrId == null) {
1688 List<BigInteger> dpnIds = getDpnsForRouter(rtrId.getValue());
1689 if (dpnIds.isEmpty()) {
1692 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1693 Long routerIdAsLong = vpnOpDataEntry.getVpnId();
1695 Uuid rtrVpnId = getVpnForRouter(rtrId, true);
1696 if (rtrVpnId == null) {
1697 //If external BGP-VPN is not associated with router then routerId is same as routerVpnId
1698 vpnId = routerIdAsLong;
1700 vpnId = getVpnId(rtrVpnId.getValue());
1702 for (BigInteger dpnId : dpnIds) {
1704 ipV6InternetDefRt.installDefaultRoute(dpnId, internetBgpVpnId, vpnId);
1706 ipV6InternetDefRt.removeDefaultRoute(dpnId, internetBgpVpnId, vpnId);
1712 public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @Nonnull Uuid vpn) {
1713 String primaryRd = getVpnRd(vpn.getValue());
1714 if (primaryRd == null) {
1715 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1716 + "Primary RD not found", choice, vpn.getValue());
1719 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1720 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1722 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1723 read(LogicalDatastoreType.OPERATIONAL, id);
1724 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1725 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1726 + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1729 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1730 if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1731 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1732 + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1735 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1736 builder.setBgpvpnType(choice);
1737 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> {
1738 tx.merge(id, builder.build(), false);
1739 LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1740 }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1743 public List<Uuid> getAssociateRouterInputRouterIdsListUuid(List<RouterIds> routerIds) {
1744 if (routerIds == null) {
1745 return Collections.emptyList();
1747 return routerIds.stream().map(
1748 routerId -> routerId.getRouterId()).collect(Collectors.toList());
1751 public List<Uuid> getDisassociateRouterInputRouterIdsListUuid(List<RouterIds> routerIds) {
1752 if (routerIds == null) {
1753 return Collections.emptyList();
1755 return routerIds.stream().map(
1756 routerId -> routerId.getRouterId()).collect(Collectors.toList());
1759 public RouterIds getvpnMapRouterIds(Uuid routerId) {
1760 return new RouterIdsBuilder().setRouterId(routerId).build();
1763 public void removeVpnMapRouterIdsFromList(Uuid routerId, List<RouterIds> vpnRouterIds) {
1764 Iterator<RouterIds> vpnRouterIdIter = vpnRouterIds.iterator();
1765 while (vpnRouterIdIter.hasNext()) {
1766 RouterIds vpnRouterId = vpnRouterIdIter.next();
1767 if (vpnRouterId.getRouterId().getValue().equals(routerId.getValue())) {
1768 vpnRouterIdIter.remove();
1775 public boolean vpnMapRouterIdsContainsRouterId(Uuid routerId, List<RouterIds> vpnRouterIds) {
1776 if (routerId == null) {
1779 return vpnRouterIds.stream().anyMatch(vpnRouterId ->
1780 vpnRouterId.getRouterId().getValue().equals(routerId.getValue()));
1783 public List<Uuid> getVpnInstanceRouterIdsListUuid(List<RouterIds> routerIds) {
1784 if (routerIds == null) {
1785 return Collections.emptyList();
1787 return routerIds.stream().map(
1788 routerId -> routerId.getRouterId()).collect(Collectors.toList());
1791 public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1792 return new RouterIdsBuilder().setRouterId(routerId).build();
1795 public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1796 List<RouterIds> listRouterIds = new ArrayList<>();
1797 for (Uuid routerId : routerIds) {
1798 final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1799 listRouterIds.add(routerIdInstance);
1801 return listRouterIds;
1805 public List<BigInteger> getDpnsForRouter(String routerUuid) {
1806 InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1807 .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1808 Optional<RouterDpnList> routerDpnListData =
1809 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1810 LogicalDatastoreType.OPERATIONAL, id);
1811 List<BigInteger> dpns = new ArrayList<>();
1812 if (routerDpnListData.isPresent()) {
1813 List<DpnVpninterfacesList> dpnVpninterfacesList = routerDpnListData.get().getDpnVpninterfacesList();
1814 for (DpnVpninterfacesList dpnVpnInterface : dpnVpninterfacesList) {
1815 dpns.add(dpnVpnInterface.getDpnId());
1821 public List<Uuid> getRouterIdsfromVpnInstance(String vpnName) {
1822 // returns only router, attached to IPv4 networks
1823 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
1824 .child(VpnMap.class, new VpnMapKey(new Uuid(vpnName))).build();
1825 Optional<VpnMap> optionalVpnMap = SingleTransactionDataBroker
1826 .syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1827 LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
1828 if (!optionalVpnMap.isPresent()) {
1829 LOG.error("getRouterIdsfromVpnInstance : Router not found for vpn : {}", vpnName);
1832 List<Uuid> rtrIds = optionalVpnMap.get().getRouterIds().stream().map(routerIds -> routerIds.getRouterId())
1833 .collect(Collectors.toList());
1838 public InstanceIdentifier<Router> buildNeutronRouterIdentifier(Uuid routerUuid) {
1839 InstanceIdentifier<Router> routerInstanceIdentifier = InstanceIdentifier.create(Neutron.class)
1840 .child(Routers.class).child(Router.class, new RouterKey(routerUuid));
1841 return routerInstanceIdentifier;
1844 List<Subnetmap> getSubnetmapListFromNetworkId(Uuid networkId) {
1845 List<Uuid> subnetIdList = getSubnetIdsFromNetworkId(networkId);
1846 if (subnetIdList != null) {
1847 List<Subnetmap> subnetmapList = new ArrayList<>();
1848 for (Uuid subnetId : subnetIdList) {
1849 Subnetmap subnetmap = getSubnetmap(subnetId);
1850 if (subnetmap != null) {
1851 subnetmapList.add(subnetmap);
1853 LOG.error("getSubnetmapListFromNetworkId: subnetmap is null for subnet {} belonging to network {}",
1854 subnetId.getValue(), networkId.getValue());
1857 return subnetmapList;
1859 LOG.error("getSubnetmapListFromNetworkId: Failed as subnetIdList is null for network {}",
1860 networkId.getValue());
1864 public long getVpnId(String vpnName) {
1865 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1866 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1867 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1868 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1869 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1870 .VpnInstance::getVpnId).orElse(null);