2 * Copyright (c) 2016, 2017 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 com.google.common.base.Optional;
12 import com.google.common.collect.ImmutableBiMap;
13 import com.google.common.collect.Sets;
14 import java.math.BigInteger;
15 import java.net.Inet4Address;
16 import java.net.Inet6Address;
17 import java.net.InetAddress;
18 import java.net.UnknownHostException;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.HashMap;
23 import java.util.HashSet;
24 import java.util.Iterator;
25 import java.util.List;
28 import java.util.concurrent.ConcurrentHashMap;
29 import java.util.concurrent.ConcurrentMap;
30 import java.util.concurrent.ExecutionException;
31 import java.util.concurrent.Future;
32 import java.util.stream.Collectors;
34 import javax.annotation.Nonnull;
35 import javax.inject.Inject;
36 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.binding.api.WriteTransaction;
41 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
42 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
43 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
44 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
45 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
46 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
47 import org.opendaylight.genius.mdsalutil.MDSALUtil;
48 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
49 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
50 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
51 import org.opendaylight.netvirt.neutronvpn.api.utils.NeutronUtils;
52 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
53 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
54 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
55 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
56 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
57 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
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.AllocateIdInput;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.Dhcpv6Base;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAclBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpPrefixOrAddress;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.IpVersionBase;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.PortSubnets;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairs;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.interfaces._interface.AllowedAddressPairsBuilder;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnet;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.PortSubnetKey;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfo;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.port.subnets.port.subnet.SubnetInfoKey;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeBase;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeFlat;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeGre;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVxlan;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntries;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.elan._interface.StaticMacEntriesBuilder;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.NeutronRouterDpns;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnList;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.RouterDpnListKey;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.neutron.router.dpns.router.dpn.list.DpnVpninterfacesList;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.FloatingIpPortInfo;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ProviderTypes;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMapping;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.floating.ip.port.info.FloatingIpIdToPortMappingKey;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.VpnMaps;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIds;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpn.instance.RouterIdsBuilder;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMap;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.VpnMapKey;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterKey;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.ExternalGatewayInfo;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeBase;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeFlat;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeGre;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVlan;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.NetworkTypeVxlan;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.Ports;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.PortKey;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.portsecurity.rev150712.PortSecurityExtension;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinkStates;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.InterVpnLinks;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkStateKey;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
157 import org.opendaylight.yangtools.yang.binding.DataObject;
158 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
159 import org.opendaylight.yangtools.yang.common.RpcResult;
160 import org.slf4j.Logger;
161 import org.slf4j.LoggerFactory;
164 public class NeutronvpnUtils {
166 private static final Logger LOG = LoggerFactory.getLogger(NeutronvpnUtils.class);
167 private static final ImmutableBiMap<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>
169 new ImmutableBiMap.Builder<Class<? extends NetworkTypeBase>, Class<? extends SegmentTypeBase>>()
170 .put(NetworkTypeFlat.class, SegmentTypeFlat.class)
171 .put(NetworkTypeGre.class, SegmentTypeGre.class)
172 .put(NetworkTypeVlan.class, SegmentTypeVlan.class)
173 .put(NetworkTypeVxlan.class, SegmentTypeVxlan.class)
176 private static final Set<Class<? extends NetworkTypeBase>> SUPPORTED_NETWORK_TYPES = new HashSet<>();
179 SUPPORTED_NETWORK_TYPES.add(NetworkTypeFlat.class);
180 SUPPORTED_NETWORK_TYPES.add(NetworkTypeVlan.class);
181 SUPPORTED_NETWORK_TYPES.add(NetworkTypeVxlan.class);
182 SUPPORTED_NETWORK_TYPES.add(NetworkTypeGre.class);
185 private final ConcurrentMap<Uuid, Network> networkMap = new ConcurrentHashMap<>();
186 private final ConcurrentMap<Uuid, Router> routerMap = new ConcurrentHashMap<>();
187 private final ConcurrentMap<Uuid, Port> portMap = new ConcurrentHashMap<>();
188 private final ConcurrentMap<Uuid, Subnet> subnetMap = new ConcurrentHashMap<>();
189 private final Map<IpAddress, Set<Uuid>> subnetGwIpMap = new ConcurrentHashMap<>();
190 private final ConcurrentMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
191 private final ConcurrentMap<Uuid, HashMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
192 private final ConcurrentMap<Uuid, HashMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
194 private final DataBroker dataBroker;
195 private final ManagedNewTransactionRunner txRunner;
196 private final IdManagerService idManager;
197 private final JobCoordinator jobCoordinator;
198 private final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt;
201 public NeutronvpnUtils(final DataBroker dataBroker, final IdManagerService idManager,
202 final JobCoordinator jobCoordinator, final IPV6InternetDefaultRouteProgrammer ipV6InternetDefRt) {
203 this.dataBroker = dataBroker;
204 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
205 this.idManager = idManager;
206 this.jobCoordinator = jobCoordinator;
207 this.ipV6InternetDefRt = ipV6InternetDefRt;
210 protected Subnetmap getSubnetmap(Uuid subnetId) {
211 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
212 Optional<Subnetmap> sn = read(LogicalDatastoreType.CONFIGURATION, id);
214 if (sn.isPresent()) {
217 LOG.error("getSubnetmap failed, subnet {} is not present", subnetId.getValue());
221 public VpnMap getVpnMap(Uuid id) {
222 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
223 new VpnMapKey(id)).build();
224 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
225 if (optionalVpnMap.isPresent()) {
226 return optionalVpnMap.get();
228 LOG.error("getVpnMap failed, VPN {} not present", id.getValue());
232 protected Uuid getVpnForNetwork(Uuid network) {
233 InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
234 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
235 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
236 List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
237 for (VpnMap vpnMap : allMaps) {
238 List<Uuid> netIds = vpnMap.getNetworkIds();
239 if (netIds != null && netIds.contains(network)) {
240 return vpnMap.getVpnId();
244 LOG.debug("getVpnForNetwork: Failed for network {} as no VPN present in VPNMaps DS", network.getValue());
248 protected Uuid getVpnForSubnet(Uuid subnetId) {
249 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
250 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
251 subnetmapIdentifier);
252 if (optionalSubnetMap.isPresent()) {
253 return optionalSubnetMap.get().getVpnId();
255 LOG.error("getVpnForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
259 protected Uuid getNetworkForSubnet(Uuid subnetId) {
260 InstanceIdentifier<Subnetmap> subnetmapIdentifier = buildSubnetMapIdentifier(subnetId);
261 Optional<Subnetmap> optionalSubnetMap = read(LogicalDatastoreType.CONFIGURATION,
262 subnetmapIdentifier);
263 if (optionalSubnetMap.isPresent()) {
264 return optionalSubnetMap.get().getNetworkId();
266 LOG.error("getNetworkForSubnet: Failed as subnetMap DS is absent for subnet {}", subnetId.getValue());
270 // @param external vpn - true if external vpn being fetched, false for internal vpn
271 protected Uuid getVpnForRouter(Uuid routerId, boolean externalVpn) {
272 if (routerId == null) {
276 InstanceIdentifier<VpnMaps> vpnMapsIdentifier = InstanceIdentifier.builder(VpnMaps.class).build();
277 Optional<VpnMaps> optionalVpnMaps = read(LogicalDatastoreType.CONFIGURATION, vpnMapsIdentifier);
278 if (optionalVpnMaps.isPresent() && optionalVpnMaps.get().getVpnMap() != null) {
279 List<VpnMap> allMaps = optionalVpnMaps.get().getVpnMap();
280 for (VpnMap vpnMap : allMaps) {
281 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps.vpnmap
282 .RouterIds> routerIdsList = vpnMap.getRouterIds();
283 if (routerIdsList == null || routerIdsList.isEmpty()) {
286 List<Uuid> rtrIdsList = routerIdsList.stream().map(routerIds -> routerIds.getRouterId())
287 .collect(Collectors.toList());
288 if (rtrIdsList.contains(routerId)) {
290 if (!routerId.equals(vpnMap.getVpnId())) {
291 return vpnMap.getVpnId();
294 if (routerId.equals(vpnMap.getVpnId())) {
295 return vpnMap.getVpnId();
301 LOG.debug("getVpnForRouter: Failed for router {} as no VPN present in VPNMaps DS", routerId.getValue());
305 protected List<Uuid> getRouterIdListforVpn(Uuid vpnId) {
306 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
307 new VpnMapKey(vpnId)).build();
308 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
309 if (optionalVpnMap.isPresent()) {
310 VpnMap vpnMap = optionalVpnMap.get();
311 return NeutronUtils.getVpnMapRouterIdsListUuid(vpnMap.getRouterIds());
313 LOG.error("getRouterIdListforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
317 protected List<Uuid> getNetworksForVpn(Uuid vpnId) {
318 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
319 new VpnMapKey(vpnId)).build();
320 Optional<VpnMap> optionalVpnMap = read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
321 if (optionalVpnMap.isPresent()) {
322 VpnMap vpnMap = optionalVpnMap.get();
323 return vpnMap.getNetworkIds();
325 LOG.error("getNetworksforVpn: Failed as VPNMaps DS is absent for VPN {}", vpnId.getValue());
329 protected List<Uuid> getSubnetsforVpn(Uuid vpnid) {
330 List<Uuid> subnets = new ArrayList<>();
332 InstanceIdentifier<Subnetmaps> subnetmapsid = InstanceIdentifier.builder(Subnetmaps.class).build();
333 Optional<Subnetmaps> subnetmaps = read(LogicalDatastoreType.CONFIGURATION, subnetmapsid);
334 if (subnetmaps.isPresent() && subnetmaps.get().getSubnetmap() != null) {
335 List<Subnetmap> subnetMapList = subnetmaps.get().getSubnetmap();
336 for (Subnetmap candidateSubnetMap : subnetMapList) {
337 if (candidateSubnetMap.getVpnId() != null && candidateSubnetMap.getVpnId().equals(vpnid)) {
338 subnets.add(candidateSubnetMap.getId());
345 protected String getNeutronPortNameFromVpnPortFixedIp(String vpnName, String fixedIp) {
346 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
347 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
348 if (vpnPortipToPortData.isPresent()) {
349 return vpnPortipToPortData.get().getPortName();
351 LOG.error("getNeutronPortNameFromVpnPortFixedIp: Failed as vpnPortipToPortData DS is absent for VPN {} and"
352 + " fixed IP {}", vpnName, fixedIp);
356 protected List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
357 InstanceIdentifier<NetworkMap> id = buildNetworkMapIdentifier(networkId);
358 Optional<NetworkMap> optionalNetworkMap = read(LogicalDatastoreType.CONFIGURATION, id);
359 if (optionalNetworkMap.isPresent()) {
360 return optionalNetworkMap.get().getSubnetIdList();
362 LOG.error("getSubnetIdsFromNetworkId: Failed as networkmap DS is absent for network {}", networkId.getValue());
366 protected List<Uuid> getPortIdsFromSubnetId(Uuid subnetId) {
367 InstanceIdentifier<Subnetmap> id = buildSubnetMapIdentifier(subnetId);
368 Optional<Subnetmap> optionalSubnetmap = read(LogicalDatastoreType.CONFIGURATION, id);
369 if (optionalSubnetmap.isPresent()) {
370 return optionalSubnetmap.get().getPortList();
375 protected Router getNeutronRouter(Uuid routerId) {
376 Router router = routerMap.get(routerId);
377 if (router != null) {
380 InstanceIdentifier<Router> inst = InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
381 .class, new RouterKey(routerId));
382 Optional<Router> rtr = read(LogicalDatastoreType.CONFIGURATION, inst);
383 if (rtr.isPresent()) {
389 public InstanceIdentifier<Router> getNeutronRouterIid(Uuid routerId) {
390 return InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router
391 .class, new RouterKey(routerId));
395 protected Network getNeutronNetwork(Uuid networkId) {
396 Network network = null;
397 network = networkMap.get(networkId);
398 if (network != null) {
401 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
402 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(Networks.class)
403 .child(Network.class, new NetworkKey(networkId));
404 Optional<Network> net = read(LogicalDatastoreType.CONFIGURATION, inst);
405 if (net.isPresent()) {
411 protected Port getNeutronPort(Uuid portId) {
412 Port prt = portMap.get(portId);
416 LOG.debug("getNeutronPort for {}", portId.getValue());
417 InstanceIdentifier<Port> inst = InstanceIdentifier.create(Neutron.class).child(Ports.class).child(Port.class,
418 new PortKey(portId));
419 Optional<Port> port = read(LogicalDatastoreType.CONFIGURATION, inst);
420 if (port.isPresent()) {
427 * Returns port_security_enabled status with the port.
429 * @param port the port
430 * @return port_security_enabled status
432 protected static boolean getPortSecurityEnabled(Port port) {
433 String deviceOwner = port.getDeviceOwner();
434 if (deviceOwner != null && deviceOwner.startsWith("network:")) {
435 // port with device owner of network:xxx is created by
436 // neutorn for its internal use. So security group doesn't apply.
437 // router interface, dhcp port and floating ip.
440 PortSecurityExtension portSecurity = port.augmentation(PortSecurityExtension.class);
441 if (portSecurity != null) {
442 return portSecurity.isPortSecurityEnabled();
448 * Gets security group UUIDs delta .
450 * @param port1SecurityGroups the port 1 security groups
451 * @param port2SecurityGroups the port 2 security groups
452 * @return the security groups delta
454 protected static List<Uuid> getSecurityGroupsDelta(List<Uuid> port1SecurityGroups,
455 List<Uuid> port2SecurityGroups) {
456 if (port1SecurityGroups == null) {
460 if (port2SecurityGroups == null) {
461 return port1SecurityGroups;
464 List<Uuid> list1 = new ArrayList<>(port1SecurityGroups);
465 List<Uuid> list2 = new ArrayList<>(port2SecurityGroups);
466 for (Iterator<Uuid> iterator = list1.iterator(); iterator.hasNext();) {
467 Uuid securityGroup1 = iterator.next();
468 for (Uuid securityGroup2 : list2) {
469 if (securityGroup1.getValue().equals(securityGroup2.getValue())) {
479 * Gets the fixed ips delta.
481 * @param port1FixedIps the port 1 fixed ips
482 * @param port2FixedIps the port 2 fixed ips
483 * @return the fixed ips delta
485 protected static List<FixedIps> getFixedIpsDelta(List<FixedIps> port1FixedIps, List<FixedIps> port2FixedIps) {
486 if (port1FixedIps == null) {
490 if (port2FixedIps == null) {
491 return port1FixedIps;
494 List<FixedIps> list1 = new ArrayList<>(port1FixedIps);
495 List<FixedIps> list2 = new ArrayList<>(port2FixedIps);
496 for (Iterator<FixedIps> iterator = list1.iterator(); iterator.hasNext();) {
497 FixedIps fixedIps1 = iterator.next();
498 for (FixedIps fixedIps2 : list2) {
499 if (fixedIps1.getIpAddress().equals(fixedIps2.getIpAddress())) {
509 * Gets the allowed address pairs delta.
511 * @param port1AllowedAddressPairs the port 1 allowed address pairs
512 * @param port2AllowedAddressPairs the port 2 allowed address pairs
513 * @return the allowed address pairs delta
515 protected static List<AllowedAddressPairs> getAllowedAddressPairsDelta(
516 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
517 .AllowedAddressPairs> port1AllowedAddressPairs,
518 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
519 .AllowedAddressPairs> port2AllowedAddressPairs) {
520 if (port1AllowedAddressPairs == null) {
524 if (port2AllowedAddressPairs == null) {
525 return getAllowedAddressPairsForAclService(port1AllowedAddressPairs);
528 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
529 .AllowedAddressPairs> list1 =
530 new ArrayList<>(port1AllowedAddressPairs);
531 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
532 .AllowedAddressPairs> list2 =
533 new ArrayList<>(port2AllowedAddressPairs);
534 for (Iterator<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
535 .AllowedAddressPairs> iterator =
536 list1.iterator(); iterator.hasNext();) {
537 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
538 .AllowedAddressPairs allowedAddressPair1 = iterator.next();
539 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
540 .AllowedAddressPairs allowedAddressPair2 : list2) {
541 if (allowedAddressPair1.key().equals(allowedAddressPair2.key())) {
547 return getAllowedAddressPairsForAclService(list1);
551 * Gets the acl allowed address pairs.
553 * @param macAddress the mac address
554 * @param ipAddress the ip address
555 * @return the acl allowed address pairs
557 protected static AllowedAddressPairs getAclAllowedAddressPairs(MacAddress macAddress,
558 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress ipAddress) {
559 AllowedAddressPairsBuilder aclAllowedAdressPairBuilder = new AllowedAddressPairsBuilder();
560 aclAllowedAdressPairBuilder.setMacAddress(macAddress);
561 if (ipAddress != null && ipAddress.getValue() != null) {
562 if (ipAddress.getIpPrefix() != null) {
563 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpPrefix()));
565 aclAllowedAdressPairBuilder.setIpAddress(new IpPrefixOrAddress(ipAddress.getIpAddress()));
568 return aclAllowedAdressPairBuilder.build();
572 * Gets the allowed address pairs for acl service.
574 * @param macAddress the mac address
575 * @param fixedIps the fixed ips
576 * @return the allowed address pairs for acl service
578 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(MacAddress macAddress,
579 List<FixedIps> fixedIps) {
580 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
581 for (FixedIps fixedIp : fixedIps) {
582 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(macAddress,
583 new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
584 fixedIp.getIpAddress().getValue())));
586 return aclAllowedAddressPairs;
590 * Gets the allowed address pairs for acl service.
592 * @param portAllowedAddressPairs the port allowed address pairs
593 * @return the allowed address pairs for acl service
595 protected static List<AllowedAddressPairs> getAllowedAddressPairsForAclService(
596 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
597 .AllowedAddressPairs> portAllowedAddressPairs) {
598 List<AllowedAddressPairs> aclAllowedAddressPairs = new ArrayList<>();
599 for (org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs
600 portAllowedAddressPair : portAllowedAddressPairs) {
601 aclAllowedAddressPairs.add(getAclAllowedAddressPairs(portAllowedAddressPair.getMacAddress(),
602 portAllowedAddressPair.getIpAddress()));
604 return aclAllowedAddressPairs;
608 * Gets the IPv6 Link Local Address corresponding to the MAC Address.
610 * @param macAddress the mac address
611 * @return the allowed address pairs for acl service which includes the MAC + IPv6LLA
613 protected static AllowedAddressPairs updateIPv6LinkLocalAddressForAclService(MacAddress macAddress) {
614 IpAddress ipv6LinkLocalAddress = getIpv6LinkLocalAddressFromMac(macAddress);
615 return getAclAllowedAddressPairs(macAddress,
616 new org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress(
617 ipv6LinkLocalAddress.getValue()));
621 * Gets the updated security groups.
623 * @param aclInterfaceSecurityGroups the acl interface security groups
624 * @param origSecurityGroups the orig security groups
625 * @param newSecurityGroups the new security groups
626 * @return the updated security groups
628 protected static List<Uuid> getUpdatedSecurityGroups(List<Uuid> aclInterfaceSecurityGroups,
629 List<Uuid> origSecurityGroups, List<Uuid> newSecurityGroups) {
630 List<Uuid> addedGroups = getSecurityGroupsDelta(newSecurityGroups, origSecurityGroups);
631 List<Uuid> deletedGroups = getSecurityGroupsDelta(origSecurityGroups, newSecurityGroups);
632 List<Uuid> updatedSecurityGroups =
633 aclInterfaceSecurityGroups != null ? new ArrayList<>(aclInterfaceSecurityGroups) : new ArrayList<>();
634 if (addedGroups != null) {
635 updatedSecurityGroups.addAll(addedGroups);
637 if (deletedGroups != null) {
638 updatedSecurityGroups.removeAll(deletedGroups);
640 return updatedSecurityGroups;
644 * Gets the allowed address pairs for fixed ips.
646 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
647 * @param portMacAddress the port mac address
648 * @param origFixedIps the orig fixed ips
649 * @param newFixedIps the new fixed ips
650 * @return the allowed address pairs for fixed ips
652 protected static List<AllowedAddressPairs> getAllowedAddressPairsForFixedIps(
653 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs, MacAddress portMacAddress,
654 List<FixedIps> origFixedIps, List<FixedIps> newFixedIps) {
655 List<FixedIps> addedFixedIps = getFixedIpsDelta(newFixedIps, origFixedIps);
656 List<FixedIps> deletedFixedIps = getFixedIpsDelta(origFixedIps, newFixedIps);
657 List<AllowedAddressPairs> updatedAllowedAddressPairs =
658 aclInterfaceAllowedAddressPairs != null
659 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
660 if (deletedFixedIps != null) {
661 updatedAllowedAddressPairs.removeAll(getAllowedAddressPairsForAclService(portMacAddress, deletedFixedIps));
663 if (addedFixedIps != null) {
664 updatedAllowedAddressPairs.addAll(getAllowedAddressPairsForAclService(portMacAddress, addedFixedIps));
666 return updatedAllowedAddressPairs;
670 * Gets the updated allowed address pairs.
672 * @param aclInterfaceAllowedAddressPairs the acl interface allowed address pairs
673 * @param origAllowedAddressPairs the orig allowed address pairs
674 * @param newAllowedAddressPairs the new allowed address pairs
675 * @return the updated allowed address pairs
677 protected static List<AllowedAddressPairs> getUpdatedAllowedAddressPairs(
678 List<AllowedAddressPairs> aclInterfaceAllowedAddressPairs,
679 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
680 .AllowedAddressPairs> origAllowedAddressPairs,
681 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes
682 .AllowedAddressPairs> newAllowedAddressPairs) {
683 List<AllowedAddressPairs> addedAllowedAddressPairs =
684 getAllowedAddressPairsDelta(newAllowedAddressPairs,origAllowedAddressPairs);
685 List<AllowedAddressPairs> deletedAllowedAddressPairs =
686 getAllowedAddressPairsDelta(origAllowedAddressPairs, newAllowedAddressPairs);
687 List<AllowedAddressPairs> updatedAllowedAddressPairs =
688 aclInterfaceAllowedAddressPairs != null
689 ? new ArrayList<>(aclInterfaceAllowedAddressPairs) : new ArrayList<>();
690 if (addedAllowedAddressPairs != null) {
691 updatedAllowedAddressPairs.addAll(addedAllowedAddressPairs);
693 if (deletedAllowedAddressPairs != null) {
694 updatedAllowedAddressPairs.removeAll(deletedAllowedAddressPairs);
696 return updatedAllowedAddressPairs;
700 * Populate interface acl builder.
702 * @param interfaceAclBuilder the interface acl builder
703 * @param port the port
705 protected static void populateInterfaceAclBuilder(InterfaceAclBuilder interfaceAclBuilder, Port port) {
706 // Handle security group enabled
707 List<Uuid> securityGroups = port.getSecurityGroups();
708 if (securityGroups != null) {
709 interfaceAclBuilder.setSecurityGroups(securityGroups);
711 List<AllowedAddressPairs> aclAllowedAddressPairs = NeutronvpnUtils.getAllowedAddressPairsForAclService(
712 port.getMacAddress(), port.getFixedIps());
713 // Update the allowed address pair with the IPv6 LLA that is auto configured on the port.
714 aclAllowedAddressPairs.add(NeutronvpnUtils.updateIPv6LinkLocalAddressForAclService(port.getMacAddress()));
715 List<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.AllowedAddressPairs>
716 portAllowedAddressPairs = port.getAllowedAddressPairs();
717 if (portAllowedAddressPairs != null) {
718 aclAllowedAddressPairs.addAll(NeutronvpnUtils.getAllowedAddressPairsForAclService(portAllowedAddressPairs));
720 interfaceAclBuilder.setAllowedAddressPairs(aclAllowedAddressPairs);
723 protected void populateSubnetInfo(Port port) {
724 List<SubnetInfo> portSubnetInfo = getSubnetInfo(port);
725 if (portSubnetInfo != null) {
726 String portId = port.getUuid().getValue();
727 InstanceIdentifier<PortSubnet> portSubnetIdentifier = buildPortSubnetIdentifier(portId);
729 PortSubnetBuilder portSubnetBuilder = new PortSubnetBuilder().withKey(new PortSubnetKey(portId))
730 .setPortId(portId).setSubnetInfo(portSubnetInfo);
732 SingleTransactionDataBroker.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL,
733 portSubnetIdentifier, portSubnetBuilder.build());
734 } catch (TransactionCommitFailedException e) {
735 LOG.error("Failed to populate subnet info for port={}", portId, e);
737 LOG.debug("Created Subnet info for port={}", portId);
741 protected List<SubnetInfo> getSubnetInfo(Port port) {
742 List<FixedIps> portFixedIps = port.getFixedIps();
743 if (portFixedIps == null) {
744 LOG.error("Failed to get Fixed IPs for the port {}", port.getName());
747 List<SubnetInfo> subnetInfoList = new ArrayList<>();
748 for (FixedIps portFixedIp : portFixedIps) {
749 Uuid subnetId = portFixedIp.getSubnetId();
750 Subnet subnet = getNeutronSubnet(subnetId);
751 if (subnet != null) {
752 Class<? extends IpVersionBase> ipVersion =
753 NeutronSecurityRuleConstants.IP_VERSION_MAP.get(subnet.getIpVersion());
754 Class<? extends Dhcpv6Base> raMode = subnet.getIpv6RaMode() == null ? null
755 : NeutronSecurityRuleConstants.RA_MODE_MAP.get(subnet.getIpv6RaMode());
756 SubnetInfo subnetInfo = new SubnetInfoBuilder().withKey(new SubnetInfoKey(subnetId))
757 .setIpVersion(ipVersion).setIpPrefix(new IpPrefixOrAddress(subnet.getCidr()))
758 .setIpv6RaMode(raMode).setGatewayIp(subnet.getGatewayIp()).build();
759 subnetInfoList.add(subnetInfo);
762 return subnetInfoList;
765 protected Subnet getNeutronSubnet(Uuid subnetId) {
766 Subnet subnet = subnetMap.get(subnetId);
767 if (subnet != null) {
770 InstanceIdentifier<Subnet> inst = InstanceIdentifier.create(Neutron.class).child(Subnets.class).child(Subnet
771 .class, new SubnetKey(subnetId));
772 Optional<Subnet> sn = read(LogicalDatastoreType.CONFIGURATION, inst);
774 if (sn.isPresent()) {
781 protected List<Uuid> getNeutronRouterSubnetIds(Uuid routerId) {
782 LOG.debug("getNeutronRouterSubnetIds for {}", routerId.getValue());
783 List<Uuid> subnetIdList = new ArrayList<>();
784 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
785 InstanceIdentifier.builder(Subnetmaps.class).build());
786 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
787 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
788 if (routerId.equals(subnetmap.getRouterId())) {
789 subnetIdList.add(subnetmap.getId());
793 LOG.debug("getNeutronRouterSubnetIds returns {}", subnetIdList);
797 // TODO Clean up the exception handling and the console output
798 @SuppressWarnings({"checkstyle:IllegalCatch", "checkstyle:RegexpSinglelineJava"})
799 protected Short getIPPrefixFromPort(Port port) {
801 Uuid subnetUUID = port.getFixedIps().get(0).getSubnetId();
802 SubnetKey subnetkey = new SubnetKey(subnetUUID);
803 InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class).child(Subnets
804 .class).child(Subnet.class, subnetkey);
805 Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
806 if (subnet.isPresent()) {
807 String cidr = String.valueOf(subnet.get().getCidr().getValue());
808 // Extract the prefix length from cidr
809 String[] parts = cidr.split("/");
810 if (parts.length == 2) {
811 return Short.valueOf(parts[1]);
813 LOG.trace("Could not retrieve prefix from subnet CIDR");
816 LOG.trace("Unable to read on subnet datastore");
818 } catch (Exception e) {
819 LOG.error("Failed to retrieve IP prefix from port for port {}", port.getUuid().getValue(), e);
821 LOG.error("Failed for port {}", port.getUuid().getValue());
825 // TODO Clean up the exception handling
826 @SuppressWarnings("checkstyle:IllegalCatch")
827 protected void createVpnPortFixedIpToPort(String vpnName, String fixedIp, String portName, String macAddress,
828 boolean isSubnetIp, WriteTransaction writeConfigTxn) {
829 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
830 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder()
831 .withKey(new VpnPortipToPortKey(fixedIp, vpnName))
832 .setVpnName(vpnName).setPortFixedip(fixedIp)
833 .setPortName(portName).setMacAddress(macAddress).setSubnetIp(isSubnetIp);
835 if (writeConfigTxn != null) {
836 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
838 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION, id, builder.build());
840 LOG.trace("Neutron port with fixedIp: {}, vpn {}, interface {}, mac {}, isSubnetIp {} added to "
841 + "VpnPortipToPort DS", fixedIp, vpnName, portName, macAddress, isSubnetIp);
842 } catch (Exception e) {
843 LOG.error("Failure while creating VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
848 // TODO Clean up the exception handling
849 @SuppressWarnings("checkstyle:IllegalCatch")
850 protected void removeVpnPortFixedIpToPort(String vpnName, String fixedIp, WriteTransaction writeConfigTxn) {
851 InstanceIdentifier<VpnPortipToPort> id = NeutronvpnUtils.buildVpnPortipToPortIdentifier(vpnName, fixedIp);
853 if (writeConfigTxn != null) {
854 writeConfigTxn.delete(LogicalDatastoreType.CONFIGURATION, id);
856 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, id);
858 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
860 } catch (Exception e) {
861 LOG.error("Failure while removing VPNPortFixedIpToPort map for vpn {} - fixedIP {}", vpnName, fixedIp,
866 // TODO Clean up the exception handling
867 @SuppressWarnings("checkstyle:IllegalCatch")
868 protected void removeLearntVpnVipToPort(String vpnName, String fixedIp) {
869 InstanceIdentifier<LearntVpnVipToPort> id = NeutronvpnUtils.buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
871 synchronized ((vpnName + fixedIp).intern()) {
872 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
874 LOG.trace("Neutron router port with fixedIp: {}, vpn {} removed from LearntVpnPortipToPort DS", fixedIp,
876 } catch (Exception e) {
877 LOG.error("Failure while removing LearntVpnPortFixedIpToPort map for vpn {} - fixedIP {}",
878 vpnName, fixedIp, e);
882 public void addToNetworkCache(Network network) {
883 networkMap.put(network.getUuid(), network);
886 public void removeFromNetworkCache(Network network) {
887 networkMap.remove(network.getUuid());
890 public void addToRouterCache(Router router) {
891 routerMap.put(router.getUuid(), router);
894 public void removeFromRouterCache(Router router) {
895 routerMap.remove(router.getUuid());
898 public Collection<Router> getAllRouters() {
899 return routerMap.values();
902 public void addToPortCache(Port port) {
903 portMap.put(port.getUuid(), port);
906 public void removeFromPortCache(Port port) {
907 portMap.remove(port.getUuid());
910 public void addToSubnetCache(Subnet subnet) {
911 subnetMap.put(subnet.getUuid(), subnet);
912 IpAddress gatewayIp = subnet.getGatewayIp();
913 if (gatewayIp != null) {
914 subnetGwIpMap.computeIfAbsent(gatewayIp, k -> Sets.newConcurrentHashSet()).add(subnet.getUuid());
918 public void removeFromSubnetCache(Subnet subnet) {
919 subnetMap.remove(subnet.getUuid());
920 IpAddress gatewayIp = subnet.getGatewayIp();
921 if (gatewayIp != null) {
922 Set<Uuid> gwIps = subnetGwIpMap.get(gatewayIp);
924 gwIps.remove(subnet.getUuid());
929 public static String getSegmentationIdFromNeutronNetwork(Network network) {
930 String segmentationId = null;
931 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
932 if (providerExtension != null) {
933 Class<? extends NetworkTypeBase> networkType = providerExtension.getNetworkType();
934 segmentationId = NeutronUtils.getSegmentationIdFromNeutronNetwork(network, networkType);
937 return segmentationId;
940 public static Class<? extends SegmentTypeBase> getSegmentTypeFromNeutronNetwork(Network network) {
941 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
942 return providerExtension != null ? NETWORK_MAP.get(providerExtension.getNetworkType()) : null;
945 public static String getPhysicalNetworkName(Network network) {
946 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
947 return providerExtension != null ? providerExtension.getPhysicalNetwork() : null;
950 public Collection<Uuid> getSubnetIdsForGatewayIp(IpAddress ipAddress) {
951 return subnetGwIpMap.getOrDefault(ipAddress, Collections.emptySet());
954 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
955 InstanceIdentifier<VpnPortipToPort> id =
956 InstanceIdentifier.builder(NeutronVpnPortipPortData.class)
957 .child(VpnPortipToPort.class, new VpnPortipToPortKey(fixedIp, vpnName)).build();
961 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName, String fixedIp) {
962 InstanceIdentifier<LearntVpnVipToPort> id =
963 InstanceIdentifier.builder(LearntVpnVipToPortData.class)
964 .child(LearntVpnVipToPort.class, new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
968 static Boolean getIsExternal(Network network) {
969 return network.augmentation(NetworkL3Extension.class) != null
970 && network.augmentation(NetworkL3Extension.class).isExternal();
973 public void addToQosPolicyCache(QosPolicy qosPolicy) {
974 qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
977 public void removeFromQosPolicyCache(QosPolicy qosPolicy) {
978 qosPolicyMap.remove(qosPolicy.getUuid());
981 public void addToQosPortsCache(Uuid qosUuid, Port port) {
982 if (qosPortsMap.containsKey(qosUuid)) {
983 if (!qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
984 qosPortsMap.get(qosUuid).put(port.getUuid(), port);
987 HashMap<Uuid, Port> newPortMap = new HashMap<>();
988 newPortMap.put(port.getUuid(), port);
989 qosPortsMap.put(qosUuid, newPortMap);
993 public void removeFromQosPortsCache(Uuid qosUuid, Port port) {
994 if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
995 qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
999 public void addToQosNetworksCache(Uuid qosUuid, Network network) {
1000 if (qosNetworksMap.containsKey(qosUuid)) {
1001 if (!qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
1002 qosNetworksMap.get(qosUuid).put(network.getUuid(), network);
1005 HashMap<Uuid, Network> newNetworkMap = new HashMap<>();
1006 newNetworkMap.put(network.getUuid(), network);
1007 qosNetworksMap.put(qosUuid, newNetworkMap);
1011 public void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
1012 if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
1013 qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
1017 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1018 InstanceIdentifier<NetworkMap> id = InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1019 NetworkMapKey(networkId)).build();
1023 static InstanceIdentifier<VpnInterface> buildVpnInterfaceIdentifier(String ifName) {
1024 InstanceIdentifier<VpnInterface> id = InstanceIdentifier.builder(VpnInterfaces.class).child(VpnInterface
1025 .class, new VpnInterfaceKey(ifName)).build();
1029 static InstanceIdentifier<Subnetmap> buildSubnetMapIdentifier(Uuid subnetId) {
1030 InstanceIdentifier<Subnetmap> id = InstanceIdentifier.builder(Subnetmaps.class).child(Subnetmap.class, new
1031 SubnetmapKey(subnetId)).build();
1035 static InstanceIdentifier<Interface> buildVlanInterfaceIdentifier(String interfaceName) {
1036 InstanceIdentifier<Interface> id = InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new
1037 InterfaceKey(interfaceName)).build();
1041 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext
1042 .routers.Routers> buildExtRoutersIdentifier(Uuid routerId) {
1043 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers
1044 .Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(org.opendaylight.yang.gen.v1.urn
1045 .opendaylight.netvirt.natservice.rev160111.ext.routers.Routers.class, new RoutersKey(routerId
1046 .getValue())).build();
1050 static InstanceIdentifier<FloatingIpIdToPortMapping> buildfloatingIpIdToPortMappingIdentifier(Uuid floatingIpId) {
1051 return InstanceIdentifier.builder(FloatingIpPortInfo.class).child(FloatingIpIdToPortMapping.class, new
1052 FloatingIpIdToPortMappingKey(floatingIpId)).build();
1055 static InstanceIdentifier<PortSubnet> buildPortSubnetIdentifier(String portId) {
1056 InstanceIdentifier<PortSubnet> id = InstanceIdentifier.builder(PortSubnets.class)
1057 .child(PortSubnet.class, new PortSubnetKey(portId)).build();
1061 // TODO Remove this method entirely
1062 @SuppressWarnings("checkstyle:IllegalCatch")
1063 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
1065 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
1066 } catch (ReadFailedException e) {
1067 throw new RuntimeException(e);
1071 public static Class<? extends NetworkTypeBase> getNetworkType(Network network) {
1072 NetworkProviderExtension providerExtension = network.augmentation(NetworkProviderExtension.class);
1073 return providerExtension != null ? providerExtension.getNetworkType() : null;
1076 static ProviderTypes getProviderNetworkType(Network network) {
1077 if (network == null) {
1078 LOG.error("Error in getting provider network type since network is null");
1081 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1083 Class<? extends NetworkTypeBase> networkTypeBase = npe.getNetworkType();
1084 if (networkTypeBase != null) {
1085 if (networkTypeBase.isAssignableFrom(NetworkTypeFlat.class)) {
1086 return ProviderTypes.FLAT;
1087 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVlan.class)) {
1088 return ProviderTypes.VLAN;
1089 } else if (networkTypeBase.isAssignableFrom(NetworkTypeVxlan.class)) {
1090 return ProviderTypes.VXLAN;
1091 } else if (networkTypeBase.isAssignableFrom(NetworkTypeGre.class)) {
1092 return ProviderTypes.GRE;
1096 LOG.error("Error in getting provider network type since network provider extension is null for network "
1097 + "{}", network.getUuid().getValue());
1101 static boolean isNetworkTypeSupported(Network network) {
1102 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1103 return npe != null && npe.getNetworkType() != null && SUPPORTED_NETWORK_TYPES.contains(npe.getNetworkType());
1106 static boolean isNetworkOfType(Network network, Class<? extends NetworkTypeBase> type) {
1107 NetworkProviderExtension npe = network.augmentation(NetworkProviderExtension.class);
1108 if (npe != null && npe.getNetworkType() != null) {
1109 return type.isAssignableFrom(npe.getNetworkType());
1114 static boolean isFlatOrVlanNetwork(Network network) {
1115 return network != null
1116 && (isNetworkOfType(network, NetworkTypeVlan.class) || isNetworkOfType(network, NetworkTypeFlat.class));
1119 static boolean isVlanOrVxlanNetwork(Class<? extends NetworkTypeBase> type) {
1120 return type.isAssignableFrom(NetworkTypeVxlan.class) || type.isAssignableFrom(NetworkTypeVlan.class);
1124 * Get inter-VPN link state.
1126 * @param vpnLinkName VPN link name
1127 * @return Optional of InterVpnLinkState
1129 public Optional<InterVpnLinkState> getInterVpnLinkState(String vpnLinkName) {
1130 InstanceIdentifier<InterVpnLinkState> vpnLinkStateIid = InstanceIdentifier.builder(InterVpnLinkStates.class)
1131 .child(InterVpnLinkState.class, new InterVpnLinkStateKey(vpnLinkName)).build();
1132 return read(LogicalDatastoreType.CONFIGURATION, vpnLinkStateIid);
1136 * Returns an InterVpnLink by searching by one of its endpoint's IP.
1138 * @param endpointIp IP to search for
1139 * @return a InterVpnLink
1141 public Optional<InterVpnLink> getInterVpnLinkByEndpointIp(String endpointIp) {
1142 InstanceIdentifier<InterVpnLinks> interVpnLinksIid = InstanceIdentifier.builder(InterVpnLinks.class).build();
1143 Optional<InterVpnLinks> interVpnLinksOpData = MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION,
1145 if (interVpnLinksOpData.isPresent()) {
1146 List<InterVpnLink> allInterVpnLinks = interVpnLinksOpData.get().getInterVpnLink();
1147 for (InterVpnLink interVpnLink : allInterVpnLinks) {
1148 if (interVpnLink.getFirstEndpoint().getIpAddress().getValue().equals(endpointIp)
1149 || interVpnLink.getSecondEndpoint().getIpAddress().getValue().equals(endpointIp)) {
1150 return Optional.of(interVpnLink);
1154 return Optional.absent();
1157 public Set<RouterDpnList> getAllRouterDpnList(BigInteger dpid) {
1158 Set<RouterDpnList> ret = new HashSet<>();
1159 InstanceIdentifier<NeutronRouterDpns> routerDpnId =
1160 InstanceIdentifier.create(NeutronRouterDpns.class);
1161 Optional<NeutronRouterDpns> neutronRouterDpnsOpt =
1162 MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, routerDpnId);
1163 if (neutronRouterDpnsOpt.isPresent()) {
1164 NeutronRouterDpns neutronRouterDpns = neutronRouterDpnsOpt.get();
1165 List<RouterDpnList> routerDpnLists = neutronRouterDpns.getRouterDpnList();
1166 for (RouterDpnList routerDpnList : routerDpnLists) {
1167 if (routerDpnList.getDpnVpninterfacesList() != null) {
1168 for (DpnVpninterfacesList dpnInterfaceList : routerDpnList.getDpnVpninterfacesList()) {
1169 if (dpnInterfaceList.getDpnId().equals(dpid)) {
1170 ret.add(routerDpnList);
1179 protected Integer getUniqueRDId(String poolName, String idKey) {
1180 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1182 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
1183 RpcResult<AllocateIdOutput> rpcResult = result.get();
1184 if (rpcResult.isSuccessful()) {
1185 return rpcResult.getResult().getIdValue().intValue();
1187 LOG.error("RPC call to get unique ID for pool name {} with ID key {} returned with errors {}",
1188 poolName, idKey, rpcResult.getErrors());
1190 } catch (InterruptedException | ExecutionException e) {
1191 LOG.error("Exception when getting Unique Id for poolname {} and ID Key {}", poolName, idKey, e);
1193 LOG.error("getUniqueRdId: Failed to return ID for poolname {} and ID Key {}", poolName, idKey);
1197 protected void releaseRDId(String poolName, String idKey) {
1198 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
1200 RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
1201 if (!rpcResult.isSuccessful()) {
1202 LOG.error("RPC Call to Get Unique Id returned with errors for poolname {} and ID Key {}: {}",
1203 poolName, idKey, rpcResult.getErrors());
1205 LOG.info("ID {} for RD released successfully", idKey);
1207 } catch (InterruptedException | ExecutionException e) {
1208 LOG.error("Exception when trying to release ID for poolname {} and ID Key {}", poolName, idKey, e);
1212 protected static IpAddress getIpv6LinkLocalAddressFromMac(MacAddress mac) {
1213 byte[] octets = bytesFromHexString(mac.getValue());
1215 /* As per the RFC2373, steps involved to generate a LLA include
1216 1. Convert the 48 bit MAC address to 64 bit value by inserting 0xFFFE
1217 between OUI and NIC Specific part.
1218 2. Invert the Universal/Local flag in the OUI portion of the address.
1219 3. Use the prefix "FE80::/10" along with the above 64 bit Interface
1220 identifier to generate the IPv6 LLA. */
1222 StringBuilder interfaceID = new StringBuilder();
1223 short u8byte = (short) (octets[0] & 0xff);
1225 interfaceID.append(Integer.toHexString(0xFF & u8byte));
1226 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[1]), 2, "0"));
1227 interfaceID.append(":");
1228 interfaceID.append(Integer.toHexString(0xFF & octets[2]));
1229 interfaceID.append("ff:fe");
1230 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[3]), 2, "0"));
1231 interfaceID.append(":");
1232 interfaceID.append(Integer.toHexString(0xFF & octets[4]));
1233 interfaceID.append(StringUtils.leftPad(Integer.toHexString(0xFF & octets[5]), 2, "0"));
1235 Ipv6Address ipv6LLA = new Ipv6Address("fe80:0:0:0:" + interfaceID.toString());
1236 IpAddress ipAddress = new IpAddress(ipv6LLA.getValue().toCharArray());
1240 protected static byte[] bytesFromHexString(String values) {
1242 if (values != null) {
1245 String[] octets = target.split(":");
1247 byte[] ret = new byte[octets.length];
1248 for (int i = 0; i < octets.length; i++) {
1249 ret[i] = Integer.valueOf(octets[i], 16).byteValue();
1254 public List<String> getExistingRDs() {
1255 List<String> existingRDs = new ArrayList<>();
1256 InstanceIdentifier<VpnInstances> path = InstanceIdentifier.builder(VpnInstances.class).build();
1257 Optional<VpnInstances> vpnInstancesOptional = read(LogicalDatastoreType.CONFIGURATION, path);
1258 if (vpnInstancesOptional.isPresent() && vpnInstancesOptional.get().getVpnInstance() != null) {
1259 for (VpnInstance vpnInstance : vpnInstancesOptional.get().getVpnInstance()) {
1260 if (vpnInstance.getIpv4Family() == null) {
1263 List<String> rds = vpnInstance.getIpv4Family().getRouteDistinguisher();
1265 existingRDs.addAll(rds);
1272 protected boolean doesVpnExist(Uuid vpnId) {
1273 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class).child(VpnMap.class,
1274 new VpnMapKey(vpnId)).build();
1275 return read(LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier).isPresent();
1278 protected Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external
1279 .subnets.Subnets> getOptionalExternalSubnets(Uuid subnetId) {
1280 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1281 .rev160111.external.subnets.Subnets> subnetsIdentifier =
1282 InstanceIdentifier.builder(ExternalSubnets.class)
1283 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice
1284 .rev160111.external.subnets.Subnets.class, new SubnetsKey(subnetId)).build();
1285 return read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1288 public static List<StaticMacEntries> buildStaticMacEntry(Port port) {
1289 PhysAddress physAddress = new PhysAddress(port.getMacAddress().getValue());
1290 List<FixedIps> fixedIps = port.getFixedIps();
1291 IpAddress ipAddress = null;
1292 if (isNotEmpty(fixedIps)) {
1293 ipAddress = port.getFixedIps().get(0).getIpAddress();
1295 StaticMacEntriesBuilder staticMacEntriesBuilder = new StaticMacEntriesBuilder();
1296 List<StaticMacEntries> staticMacEntries = new ArrayList<>();
1297 if (ipAddress != null) {
1298 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).setIpPrefix(ipAddress).build());
1300 staticMacEntries.add(staticMacEntriesBuilder.setMacAddress(physAddress).build());
1302 return staticMacEntries;
1305 public static boolean isEmpty(Collection<?> collection) {
1306 return collection == null || collection.isEmpty();
1309 public static boolean isNotEmpty(Collection<?> collection) {
1310 return !isEmpty(collection);
1314 * Method to get an ipVersionChosen as IPV4 and/or IPV6 or undefined from the subnetmaps of the router.
1315 * @param routerUuid the Uuid for which find out the IP version associated
1316 * @return an IpVersionChoice used by the router from its attached subnetmaps. IpVersionChoice.UNDEFINED if any
1318 public IpVersionChoice getIpVersionChoicesFromRouterUuid(Uuid routerUuid) {
1319 IpVersionChoice rep = IpVersionChoice.UNDEFINED;
1320 if (routerUuid == null) {
1323 List<Subnetmap> subnetmapList = getNeutronRouterSubnetMaps(routerUuid);
1324 if (subnetmapList.isEmpty()) {
1327 for (Subnetmap sn : subnetmapList) {
1328 if (sn.getSubnetIp() != null) {
1329 IpVersionChoice ipVers = getIpVersionFromString(sn.getSubnetIp());
1330 if (rep.choice != ipVers.choice) {
1331 rep = rep.addVersion(ipVers);
1333 if (rep.choice == IpVersionChoice.IPV4AND6.choice) {
1341 /**This method return the list of Subnetmap associated to the router or a empty list if any.
1342 * @param routerId the Uuid of router for which subnetmap is find out
1343 * @return a list of Subnetmap associated to the router. it could be empty if any
1345 protected List<Subnetmap> getNeutronRouterSubnetMaps(Uuid routerId) {
1346 List<Subnetmap> subnetIdList = new ArrayList<>();
1347 Optional<Subnetmaps> subnetMaps = read(LogicalDatastoreType.CONFIGURATION,
1348 InstanceIdentifier.builder(Subnetmaps.class).build());
1349 if (subnetMaps.isPresent() && subnetMaps.get().getSubnetmap() != null) {
1350 for (Subnetmap subnetmap : subnetMaps.get().getSubnetmap()) {
1351 if (routerId.equals(subnetmap.getRouterId())) {
1352 subnetIdList.add(subnetmap);
1356 return subnetIdList;
1359 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1360 .instance.to.vpn.id.VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
1361 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
1362 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1363 .instance.to.vpn.id.VpnInstance.class,
1364 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1365 .instance.to.vpn.id.VpnInstanceKey(vpnName)).build();
1369 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
1370 * @param vpnName Name of the VPN
1372 * @return the route-distinguisher of the VPN
1374 public String getVpnRd(String vpnName) {
1375 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn
1376 .instance.to.vpn.id.VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
1377 return SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1378 LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
1379 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
1380 .VpnInstance::getVrfId).orElse(null);
1383 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1384 * @param ipAddress String of an representation IP address V4 or V6
1385 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1387 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1388 IpVersionChoice ipchoice = IpVersionChoice.UNDEFINED;
1389 if (ipAddress.contains("/")) {
1390 ipAddress = ipAddress.substring(0, ipAddress.indexOf("/"));
1393 InetAddress address = InetAddress.getByName(ipAddress);
1394 if (address instanceof Inet4Address) {
1395 return IpVersionChoice.IPV4;
1396 } else if (address instanceof Inet6Address) {
1397 return IpVersionChoice.IPV6;
1399 } catch (UnknownHostException | SecurityException e) {
1400 LOG.error("getIpVersionFromString: could not find version for {}", ipAddress);
1405 /**Get IpVersionChoice from Uuid Subnet.
1406 * @param sm Subnetmap structure
1407 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1409 public static IpVersionChoice getIpVersionFromSubnet(Subnetmap sm) {
1410 if (sm != null && sm.getSubnetIp() != null) {
1411 return getIpVersionFromString(sm.getSubnetIp());
1413 return IpVersionChoice.UNDEFINED;
1416 public VpnInstanceOpDataEntry getVpnInstanceOpDataEntryFromVpnId(String vpnName) {
1417 String primaryRd = getVpnRd(vpnName);
1418 if (primaryRd == null) {
1419 LOG.error("getVpnInstanceOpDataEntryFromVpnId: Vpn Instance {} "
1420 + "Primary RD not found", vpnName);
1423 InstanceIdentifier<VpnInstanceOpDataEntry> id = getVpnOpDataIdentifier(primaryRd);
1424 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1425 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1426 LOG.error("getVpnInstanceOpDataEntryFromVpnId: VpnInstance {} not found", primaryRd);
1429 return vpnInstanceOpDataEntryOptional.get();
1432 protected InstanceIdentifier<VpnInstanceOpDataEntry> getVpnOpDataIdentifier(String primaryRd) {
1433 return InstanceIdentifier.builder(VpnInstanceOpData.class)
1434 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1437 public boolean shouldVpnHandleIpVersionChangeToAdd(Subnetmap sm, Uuid vpnId) {
1441 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1442 return shouldVpnHandleIpVersionChoiceChangeToAdd(ipVersion, vpnId);
1445 public boolean shouldVpnHandleIpVersionChoiceChangeToAdd(IpVersionChoice ipVersion, Uuid vpnId) {
1446 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnId.getValue());
1447 if (vpnInstanceOpDataEntry == null) {
1450 if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1451 LOG.error("shouldVpnHandleIpVersionChangeToAdd: {} "
1452 + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnId.getValue());
1455 boolean isIpv4Configured = vpnInstanceOpDataEntry.isIpv4Configured();
1456 boolean isVpnInstanceIpv4Changed = false;
1457 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV4) && !isIpv4Configured) {
1458 isVpnInstanceIpv4Changed = true;
1460 boolean isIpv6Configured = vpnInstanceOpDataEntry.isIpv6Configured();
1461 boolean isVpnInstanceIpv6Changed = false;
1462 if (ipVersion.isIpVersionChosen(IpVersionChoice.IPV6) && !isIpv6Configured) {
1463 isVpnInstanceIpv6Changed = true;
1465 if (!isVpnInstanceIpv4Changed && !isVpnInstanceIpv6Changed) {
1466 LOG.debug("shouldVpnHandleIpVersionChangeToAdd: VPN {} did not change with IpFamily {}",
1467 vpnId.getValue(), ipVersion.toString());
1473 public boolean shouldVpnHandleIpVersionChangeToRemove(Subnetmap sm, Uuid vpnId) {
1477 InstanceIdentifier<Subnetmaps> subnetMapsId = InstanceIdentifier.builder(Subnetmaps.class).build();
1478 Optional<Subnetmaps> allSubnetMaps = read(LogicalDatastoreType.CONFIGURATION, subnetMapsId);
1479 // calculate and store in list IpVersion for each subnetMap, belonging to current VpnInstance
1480 List<IpVersionChoice> snIpVersions = new ArrayList<>();
1481 for (Subnetmap snMap: allSubnetMaps.get().getSubnetmap()) {
1482 if (snMap.getId().equals(sm.getId())) {
1485 if (snMap.getVpnId() != null && snMap.getVpnId().equals(vpnId)) {
1486 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1488 if (snMap.getInternetVpnId() != null && snMap.getInternetVpnId().equals(vpnId)) {
1489 snIpVersions.add(getIpVersionFromString(snMap.getSubnetIp()));
1492 IpVersionChoice ipVersion = getIpVersionFromString(sm.getSubnetIp());
1493 if (!snIpVersions.contains(ipVersion)) {
1499 public void updateVpnInstanceWithIpFamily(String vpnName, IpVersionChoice ipVersion, boolean add) {
1500 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1501 if (vpnInstanceOpDataEntry == null) {
1504 if (vpnInstanceOpDataEntry.getType() == VpnInstanceOpDataEntry.Type.L2) {
1505 LOG.debug("updateVpnInstanceWithIpFamily: Update VpnInstance {} with ipFamily {}."
1506 + "VpnInstanceOpDataEntry is L2 instance. Do nothing.", vpnName,
1507 ipVersion.toString());
1510 final boolean isFinalVpnInstanceIpv6Changed = ipVersion
1511 .isIpVersionChosen(IpVersionChoice.IPV6) ? true : false;
1512 final boolean isFinalVpnInstanceIpv4Changed = ipVersion
1513 .isIpVersionChosen(IpVersionChoice.IPV4) ? true : false;
1514 final boolean finalIsIpv4Configured = ipVersion.isIpVersionChosen(IpVersionChoice.IPV4) ? add : false;
1515 final boolean finalIsIpv6Configured = ipVersion.isIpVersionChosen(IpVersionChoice.IPV6) ? add : false;
1516 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
1517 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1518 if (isFinalVpnInstanceIpv4Changed) {
1519 builder.setIpv4Configured(finalIsIpv4Configured);
1521 if (isFinalVpnInstanceIpv6Changed) {
1522 builder.setIpv6Configured(finalIsIpv6Configured);
1524 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> {
1525 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1526 .child(VpnInstanceOpDataEntry.class,
1527 new VpnInstanceOpDataEntryKey(vpnInstanceOpDataEntry.getVrfId())).build();
1528 tx.merge(LogicalDatastoreType.OPERATIONAL, id, builder.build(), false);
1529 LOG.info("updateVpnInstanceWithIpFamily: Successfully {} {} to Vpn {}",
1530 add ? "added" : "removed",
1531 ipVersion.toString(), vpnName);
1537 * Get the vpnInstance from its Uuid.
1539 * @param broker to get informations from ds
1540 * @param vpnId the Uuid of the VPN
1541 * @return the VpnInstance or null if unfindable
1543 public VpnInstance getVpnInstance(DataBroker broker, Uuid vpnId) {
1544 if (broker == null || vpnId == null) {
1547 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
1548 new VpnInstanceKey(vpnId.getValue())).build();
1549 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1550 return vpnInstance.isPresent() ? vpnInstance.get() : null;
1554 *Get the Uuid of external network of the router (remember you that one router have only one external network).
1555 * @param routerId the Uuid of the router which you try to reach the external network
1556 * @return Uuid of externalNetwork or null if is not exist
1558 protected Uuid getExternalNetworkUuidAttachedFromRouterUuid(@Nonnull Uuid routerId) {
1559 LOG.debug("getExternalNetworkUuidAttachedFromRouterUuid for {}", routerId.getValue());
1560 Uuid externalNetworkUuid = null;
1561 Router router = getNeutronRouter(routerId);
1562 if (router != null && router.getExternalGatewayInfo() != null) {
1563 externalNetworkUuid = router.getExternalGatewayInfo().getExternalNetworkId();
1565 return externalNetworkUuid;
1568 public Uuid getInternetvpnUuidBoundToRouterId(@Nonnull Uuid routerId) {
1569 Uuid netId = getExternalNetworkUuidAttachedFromRouterUuid(routerId);
1570 if (netId == null) {
1573 return getVpnForNetwork(netId);
1577 * This method get Uuid of internet vpn if existing one bound to the same router of the subnetUuid arg.
1578 * Explanation: If the subnet (of arg subnetUuid) have a router bound and this router have an
1579 * externalVpn (vpn on externalProvider network) then <b>its Uuid</b> will be returned.
1580 * @param subnetUuid Uuid of subnet where you are finding a link to an external network
1581 * @return Uuid of externalVpn or null if it is not found
1583 public Uuid getInternetvpnUuidBoundToSubnetRouter(@Nonnull Uuid subnetUuid) {
1584 Subnetmap subnetmap = getSubnetmap(subnetUuid);
1585 Uuid routerUuid = subnetmap.getRouterId();
1586 LOG.debug("getInternetvpnUuidBoundToSubnetRouter for subnetUuid {}", subnetUuid.getValue());
1587 if (routerUuid == null) {
1590 Uuid externalNetworkUuid = getExternalNetworkUuidAttachedFromRouterUuid(routerUuid);
1591 return externalNetworkUuid != null ? getVpnForNetwork(externalNetworkUuid) : null;
1595 * Get a list of Private Subnetmap Ids from router to export then its prefixes in Internet VPN.
1596 * @param extNet Provider Network, which has a port attached as external network gateway to router
1597 * @return a list of Private Subnetmap Ids of the router with external network gateway
1599 public @Nonnull List<Uuid> getPrivateSubnetsToExport(@Nonnull Network extNet) {
1600 List<Uuid> subList = new ArrayList<>();
1601 Uuid extNetVpnId = getVpnForNetwork(extNet.getUuid());
1602 if (extNetVpnId == null) {
1605 for (Uuid rtrId: getRouterIdListforVpn(extNetVpnId)) {
1606 Router router = getNeutronRouter(rtrId);
1607 ExternalGatewayInfo info = router.getExternalGatewayInfo();
1609 LOG.error("getPrivateSubnetsToExport: can not get info about external gateway for router {}",
1610 router.getUuid().getValue());
1613 // check that router really has given provider network as its external gateway port
1614 if (!extNet.getUuid().equals(info.getExternalNetworkId())) {
1615 LOG.error("getPrivateSubnetsToExport: router {} is not attached to given provider network {}",
1616 router.getUuid().getValue(), extNet.getUuid().getValue());
1619 subList.addAll(getSubnetsforVpn(rtrId));
1624 public void updateVpnInstanceWithFallback(String vpnName, boolean add) {
1625 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(vpnName);
1626 if (vpnInstanceOpDataEntry == null) {
1627 LOG.error("updateVpnInstanceWithFallback: vpnInstanceOpDataEntry not found for vpn {}", vpnName);
1630 Long vpnId = vpnInstanceOpDataEntry.getVpnId();
1631 List<Uuid> routerIds = getRouterIdsfromVpnInstance(vpnInstanceOpDataEntry.getVrfId());
1632 if ((routerIds == null) || (routerIds.isEmpty())) {
1633 LOG.error("updateVpnInstanceWithFallback: router not found for vpn {}", vpnName);
1636 for (Uuid rtrId: routerIds) {
1637 if (rtrId == null) {
1640 List<BigInteger> dpnIds = getDpnsForRouter(rtrId.getValue());
1641 if (dpnIds.isEmpty()) {
1644 VpnInstanceOpDataEntry vpnOpDataEntry = getVpnInstanceOpDataEntryFromVpnId(rtrId.getValue());
1645 Long routerIdAsLong = vpnOpDataEntry.getVpnId();
1646 for (BigInteger dpnId : dpnIds) {
1648 ipV6InternetDefRt.installDefaultRoute(dpnId, vpnId, routerIdAsLong);
1650 ipV6InternetDefRt.removeDefaultRoute(dpnId, vpnId, routerIdAsLong);
1656 public void updateVpnInstanceOpWithType(VpnInstanceOpDataEntry.BgpvpnType choice, @Nonnull Uuid vpn) {
1657 String primaryRd = getVpnRd(vpn.getValue());
1658 if (primaryRd == null) {
1659 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1660 + "Primary RD not found", choice, vpn.getValue());
1663 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1664 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1666 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional =
1667 read(LogicalDatastoreType.OPERATIONAL, id);
1668 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1669 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1670 + "VpnInstanceOpDataEntry not found", choice, vpn.getValue());
1673 VpnInstanceOpDataEntry vpnInstanceOpDataEntry = vpnInstanceOpDataEntryOptional.get();
1674 if (vpnInstanceOpDataEntry.getBgpvpnType().equals(choice)) {
1675 LOG.debug("updateVpnInstanceOpWithType: Update BgpvpnType {} for {}."
1676 + "VpnInstanceOpDataEntry already set", choice, vpn.getValue());
1679 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder(vpnInstanceOpDataEntry);
1680 builder.setBgpvpnType(choice);
1681 ListenableFutures.addErrorLogging(txRunner.callWithNewWriteOnlyTransactionAndSubmit(tx -> {
1682 tx.merge(LogicalDatastoreType.OPERATIONAL, id, builder.build(), false);
1683 LOG.debug("updateVpnInstanceOpWithType: sent merge to operDS BgpvpnType {} for {}", choice, vpn.getValue());
1684 }), LOG, "Error updating VPN instance op {} with type {}", vpn, choice);
1687 public List<Uuid> getAssociateRouterInputRouterIdsListUuid(List<RouterIds> routerIds) {
1688 if (routerIds == null) {
1689 return Collections.emptyList();
1691 return routerIds.stream().map(
1692 routerId -> routerId.getRouterId()).collect(Collectors.toList());
1695 public List<Uuid> getDisassociateRouterInputRouterIdsListUuid(List<RouterIds> routerIds) {
1696 if (routerIds == null) {
1697 return Collections.emptyList();
1699 return routerIds.stream().map(
1700 routerId -> routerId.getRouterId()).collect(Collectors.toList());
1703 public RouterIds getvpnMapRouterIds(Uuid routerId) {
1704 return new RouterIdsBuilder().setRouterId(routerId).build();
1707 public void removeVpnMapRouterIdsFromList(Uuid routerId, List<RouterIds> vpnRouterIds) {
1708 Iterator<RouterIds> vpnRouterIdIter = vpnRouterIds.iterator();
1709 while (vpnRouterIdIter.hasNext()) {
1710 RouterIds vpnRouterId = vpnRouterIdIter.next();
1711 if (vpnRouterId.getRouterId().getValue().equals(routerId.getValue())) {
1712 vpnRouterIdIter.remove();
1719 public boolean vpnMapRouterIdsContainsRouterId(Uuid routerId, List<RouterIds> vpnRouterIds) {
1720 if (routerId == null) {
1723 return vpnRouterIds.stream().anyMatch(vpnRouterId ->
1724 vpnRouterId.getRouterId().getValue().equals(routerId.getValue()));
1727 public List<Uuid> getVpnInstanceRouterIdsListUuid(List<RouterIds> routerIds) {
1728 if (routerIds == null) {
1729 return Collections.emptyList();
1731 return routerIds.stream().map(
1732 routerId -> routerId.getRouterId()).collect(Collectors.toList());
1735 public static RouterIds getvpnInstanceRouterIds(Uuid routerId) {
1736 return new RouterIdsBuilder().setRouterId(routerId).build();
1739 public static List<RouterIds> getVpnInstanceRouterIdsList(List<Uuid> routerIds) {
1740 List<RouterIds> listRouterIds = new ArrayList<>();
1741 for (Uuid routerId : routerIds) {
1742 final RouterIds routerIdInstance = getvpnInstanceRouterIds(routerId);
1743 listRouterIds.add(routerIdInstance);
1745 return listRouterIds;
1749 public List<BigInteger> getDpnsForRouter(String routerUuid) {
1750 InstanceIdentifier id = InstanceIdentifier.builder(NeutronRouterDpns.class)
1751 .child(RouterDpnList.class, new RouterDpnListKey(routerUuid)).build();
1752 Optional<RouterDpnList> routerDpnListData =
1753 SingleTransactionDataBroker.syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1754 LogicalDatastoreType.OPERATIONAL, id);
1755 List<BigInteger> dpns = new ArrayList<>();
1756 if (routerDpnListData.isPresent()) {
1757 List<DpnVpninterfacesList> dpnVpninterfacesList = routerDpnListData.get().getDpnVpninterfacesList();
1758 for (DpnVpninterfacesList dpnVpnInterface : dpnVpninterfacesList) {
1759 dpns.add(dpnVpnInterface.getDpnId());
1765 public List<Uuid> getRouterIdsfromVpnInstance(String vpnName) {
1766 // returns only router, attached to IPv4 networks
1767 InstanceIdentifier<VpnMap> vpnMapIdentifier = InstanceIdentifier.builder(VpnMaps.class)
1768 .child(VpnMap.class, new VpnMapKey(new Uuid(vpnName))).build();
1769 Optional<VpnMap> optionalVpnMap = SingleTransactionDataBroker
1770 .syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(dataBroker,
1771 LogicalDatastoreType.CONFIGURATION, vpnMapIdentifier);
1772 if (!optionalVpnMap.isPresent()) {
1773 LOG.error("getRouterIdsfromVpnInstance : Router not found for vpn : {}", vpnName);
1776 List<Uuid> rtrIds = optionalVpnMap.get().getRouterIds().stream().map(routerIds -> routerIds.getRouterId())
1777 .collect(Collectors.toList());
1782 public InstanceIdentifier<Router> buildNeutronRouterIdentifier(Uuid routerUuid) {
1783 InstanceIdentifier<Router> routerInstanceIdentifier = InstanceIdentifier.create(Neutron.class)
1784 .child(Routers.class).child(Router.class, new RouterKey(routerUuid));
1785 return routerInstanceIdentifier;