neutron-mapper/src/main/java/org/opendaylight/groupbasedpolicy/neutron/mapper/mapping/NeutronSubnetAware.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.groupbasedpolicy.neutron.mapper.mapping;
   9
  10 import static com.google.common.base.Preconditions.checkNotNull;
  11
  12 import java.util.ArrayList;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import java.util.function.Function;
  16 import java.util.stream.Collectors;
  17 import java.util.stream.Stream;
  18
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  22 import org.opendaylight.groupbasedpolicy.domain_extension.l2_l3.util.L2L3IidFactory;
  23 import org.opendaylight.groupbasedpolicy.neutron.mapper.EndpointRegistrator;
  24 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
  25 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.NetworkUtils;
  26 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
  27 import org.opendaylight.groupbasedpolicy.util.IidFactory;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContextId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Name;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.NetworkDomainId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubnetId;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.L2FloodDomain;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.SubnetAugmentForwarding;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.SubnetAugmentForwardingBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.SubnetBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.subnet.AllocationPool;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.subnet.AllocationPoolBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.subnet.DhcpServers;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.subnet.DhcpServersBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.subnet.GatewaysBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.subnet.gateways.PrefixesBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.forwarding.by.tenant.NetworkDomain;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.forwarding.by.tenant.NetworkDomainBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.Subnet;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.binding.rev150712.PortBindingExtension;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.provider.ext.rev150712.NetworkProviderExtension;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnet.attributes.AllocationPools;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
  56 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 import com.google.common.base.Optional;
  61 import com.google.common.base.Strings;
  62
  63 public class NeutronSubnetAware implements
  64         NeutronAware<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet> {
  65
  66     private final static Logger LOG = LoggerFactory.getLogger(NeutronSubnetAware.class);
  67     public static final InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet> SUBNET_WILDCARD_IID =
  68             InstanceIdentifier.builder(Neutron.class)
  69                 .child(Subnets.class)
  70                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet.class)
  71                 .build();
  72     private final DataBroker dataProvider;
  73     private final EndpointRegistrator epRegistrator;
  74
  75     public NeutronSubnetAware(DataBroker dataProvider, EndpointRegistrator epRegistrator) {
  76         this.dataProvider = checkNotNull(dataProvider);
  77         this.epRegistrator = checkNotNull(epRegistrator);
  78     }
  79
  80     @Override
  81     public void onCreated(
  82             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet,
  83             Neutron neutron) {
  84         LOG.trace("created subnet - {}", neutronSubnet);
  85         ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
  86         TenantId tenantId = new TenantId(neutronSubnet.getTenantId().getValue());
  87
  88         Optional<Network> potentialNetwork =
  89                 NetworkUtils.findNetwork(neutronSubnet.getNetworkId(), neutron.getNetworks());
  90         if (!potentialNetwork.isPresent()) {
  91             LOG.warn("Illegal state - network {} does not exist for subnet {}.",
  92                     neutronSubnet.getNetworkId().getValue(), neutronSubnet);
  93             rwTx.cancel();
  94             return;
  95         }
  96
  97         Network networkOfSubnet = potentialNetwork.get();
  98
  99         NetworkDomain subnetDomain;
 100         IpAddress gatewayIp = neutronSubnet.getGatewayIp();
 101         if (NetworkUtils.isProviderPhysicalNetwork(networkOfSubnet)) {
 102             // add virtual router IP only in case it is provider physical network
 103             subnetDomain = createSubnet(neutronSubnet, neutron, gatewayIp);
 104             boolean registeredDefaultRoute = epRegistrator.registerExternalL3PrefixEndpoint(MappingUtils.DEFAULT_ROUTE,
 105                     new L3ContextId(neutronSubnet.getNetworkId().getValue()), gatewayIp, tenantId);
 106             if (!registeredDefaultRoute) {
 107                 LOG.warn("Could not add EndpointL3Prefix as default route. Subnet within provider physical network {}",
 108                     neutronSubnet);
 109                 rwTx.cancel();
 110                 return;
 111             }
 112         } else {
 113             // virtual router IP is not set and it will be set when router gateway port is set
 114             // or when a router port is attached to a network
 115             if (NetworkUtils.isRouterExternal(networkOfSubnet)) {
 116                 subnetDomain = createSubnet(neutronSubnet, neutron, gatewayIp);
 117             } else {
 118                 subnetDomain = createSubnet(neutronSubnet, neutron, null);
 119             }
 120         }
 121         processTenantSubnet(neutronSubnet, networkOfSubnet, tenantId, rwTx);
 122         rwTx.put(LogicalDatastoreType.CONFIGURATION,
 123             L2L3IidFactory.subnetIid(tenantId, subnetDomain.getNetworkDomainId()), subnetDomain, true);
 124         DataStoreHelper.submitToDs(rwTx);
 125     }
 126
 127     public static NetworkDomain createSubnet(
 128             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet,
 129             Neutron neutron, IpAddress gwIpAddress) {
 130         SubnetBuilder sb = new SubnetBuilder();
 131         sb.setIpPrefix(subnet.getCidr());
 132         sb.setDhcpServers(resolveDhcpServerIp(neutron, subnet));
 133         sb.setDefaultSubnetGatewayIp(subnet.getGatewayIp());
 134         if (gwIpAddress != null) {
 135             sb.setGateways(Collections.singletonList(new GatewaysBuilder().setGateway(gwIpAddress)
 136                 .setPrefixes(
 137                     Collections.singletonList(new PrefixesBuilder().setPrefix(MappingUtils.DEFAULT_ROUTE).build()))
 138                 .build()));
 139         }
 140         if (neutron.getPorts() != null && neutron.getPorts().getPort() != null) {
 141             for (Port port : neutron.getPorts().getPort()) {
 142                 if (port.getFixedIps() == null || port.getFixedIps().stream()
 143                     .noneMatch(fi -> fi.getSubnetId().equals(subnet.getUuid()))) {
 144                     continue;
 145                 }
 146                 if (neutron.getRouters() != null && neutron.getRouters().getRouter() != null && neutron.getRouters()
 147                     .getRouter()
 148                     .stream()
 149                     .anyMatch(r -> !r.getUuid().getValue().equals(port.getDeviceOwner()))) {
 150                     // virtual router IP is set when a router port is attached to a network
 151                     sb.setVirtualRouterIp(subnet.getGatewayIp());
 152                 } else if (neutron.getNetworks() != null && neutron.getNetworks().getNetwork() != null && neutron
 153                     .getNetworks()
 154                     .getNetwork()
 155                     .stream()
 156                     .filter(net -> net.getUuid().equals(port.getNetworkId()))
 157                     .filter(net -> net.getAugmentation(NetworkProviderExtension.class) != null)
 158                     .anyMatch(net -> net.getAugmentation(NetworkProviderExtension.class).getPhysicalNetwork() != null)) {
 159                     // add virtual router IP only in case it is provider physical network
 160                     sb.setVirtualRouterIp(subnet.getGatewayIp());
 161                 }
 162             }
 163         }
 164         Optional<Network> potentialNetwork =
 165                 NetworkUtils.findNetwork(subnet.getNetworkId(), neutron.getNetworks());
 166         if (potentialNetwork.isPresent()) {
 167             sb.setIsTenant(NetworkUtils.isTenantNetwork(potentialNetwork.get()));
 168         }
 169         if (subnet.getAllocationPools() != null) {
 170             List<AllocationPool> pools =
 171                     subnet.getAllocationPools().stream().map(new Function<AllocationPools, AllocationPool>() {
 172
 173                         @Override
 174                         public AllocationPool apply(AllocationPools ap) {
 175                             IpAddress start = ap.getStart();
 176                             IpAddress end = ap.getEnd();
 177                             AllocationPoolBuilder ab = new AllocationPoolBuilder();
 178                             if (start.getIpv4Address() != null || end.getIpv4Address() != null) {
 179                                 ab.setFirst(start.getIpv4Address().getValue());
 180                                 ab.setLast(end.getIpv4Address().getValue());
 181                             } else {
 182                                 ab.setFirst(start.getIpv6Address().getValue());
 183                                 ab.setLast(end.getIpv6Address().getValue());
 184                             }
 185                             return ab.build();
 186                         }
 187                     }).collect(Collectors.toList());
 188             sb.setAllocationPool(pools);
 189         }
 190         NetworkDomainBuilder ndb = new NetworkDomainBuilder();
 191         if (!Strings.isNullOrEmpty(subnet.getName())) {
 192             try {
 193                 ndb.setName(new Name(subnet.getName()));
 194             } catch (Exception e) {
 195                 LOG.info("Name '{}' of Neutron Subnet '{}' is ignored.", subnet.getName(), subnet.getUuid().getValue());
 196                 LOG.debug("Name exception", e);
 197             }
 198         }
 199         ndb.setNetworkDomainId(new NetworkDomainId(subnet.getUuid().getValue()));
 200         ndb.setNetworkDomainType(MappingUtils.SUBNET);
 201         ndb.setParent(MappingUtils.createParent(new NetworkDomainId(subnet.getNetworkId().getValue()), L2FloodDomain.class));
 202         ndb.addAugmentation(SubnetAugmentForwarding.class, new SubnetAugmentForwardingBuilder().setSubnet(sb.build())
 203             .build());
 204         return ndb.build();
 205     }
 206
 207     private static List<DhcpServers> resolveDhcpServerIp(Neutron neutron,
 208         org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet) {
 209         if (neutron == null || neutron.getPorts() == null || neutron.getPorts().getPort() == null) {
 210             return new ArrayList<>();
 211         }
 212         final List<DhcpServers> dhcpServers = new ArrayList<>();
 213
 214         Stream<Port> ports = neutron.getPorts().getPort().stream()
 215             .filter(port -> subnet.getNetworkId().equals(port.getNetworkId()))
 216             .filter(port -> port.getDeviceId().contains(subnet.getNetworkId().getValue()));
 217
 218         ports.forEach(port -> {
 219             java.util.Optional<FixedIps> optionalDhcpServerIp = port.getFixedIps().stream().findFirst();
 220             PortBindingExtension portBindingExtension = port.getAugmentation(PortBindingExtension.class);
 221             if (optionalDhcpServerIp.isPresent() && portBindingExtension != null && subnet.getUuid()
 222                 .equals(optionalDhcpServerIp.get().getSubnetId())) {
 223                 dhcpServers.add(new DhcpServersBuilder()
 224                     .setDhcpServerIp(optionalDhcpServerIp.get().getIpAddress())
 225                     .setNode(portBindingExtension.getHostId())
 226                     .build());
 227                 LOG.trace("Found DHCP server IP address: {} for node: {} in subnet: {}",
 228                     optionalDhcpServerIp.get().getIpAddress(), portBindingExtension.getHostId(), subnet);
 229             }
 230         });
 231         return dhcpServers;
 232     }
 233
 234     @Deprecated
 235     private void processTenantSubnet(org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet, Network networkOfSubnet, TenantId tenantId, ReadWriteTransaction rwTx) {
 236         Subnet subnet;
 237         if (NetworkUtils.isProviderPhysicalNetwork(networkOfSubnet)) {
 238             // add virtual router IP only in case it is provider physical network
 239             subnet = createTenantSubnet(neutronSubnet, neutronSubnet.getGatewayIp());
 240             IpAddress gatewayIp = neutronSubnet.getGatewayIp();
 241             boolean registeredDefaultRoute = epRegistrator.registerExternalL3PrefixEndpoint(MappingUtils.DEFAULT_ROUTE,
 242                     new L3ContextId(neutronSubnet.getNetworkId().getValue()), gatewayIp, tenantId);
 243             if (!registeredDefaultRoute) {
 244                 LOG.warn("Could not add EndpointL3Prefix as default route. Subnet within provider physical network {}",
 245                         neutronSubnet);
 246                 rwTx.cancel();
 247                 return;
 248             }
 249         } else {
 250             // virtual router IP is not set and it will be set when router gateway port is set
 251             // or when a router port is attached to a network
 252             subnet = createTenantSubnet(neutronSubnet, null);
 253         }
 254         rwTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.subnetIid(tenantId, subnet.getId()), subnet, true);
 255     }
 256
 257     @Deprecated
 258     public static Subnet createTenantSubnet(
 259             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet,
 260             IpAddress virtualRouterIp) {
 261         org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.SubnetBuilder subnetBuilder = new org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.SubnetBuilder();
 262         subnetBuilder.setId(new SubnetId(subnet.getUuid().getValue()));
 263         subnetBuilder.setParent(new ContextId(subnet.getNetworkId().getValue()));
 264         if (!Strings.isNullOrEmpty(subnet.getName())) {
 265             try {
 266                 subnetBuilder.setName(new Name(subnet.getName()));
 267             } catch (Exception e) {
 268                 LOG.info("Name '{}' of Neutron Subnet '{}' is ignored.", subnet.getName(),
 269                         subnet.getUuid().getValue());
 270                 LOG.debug("Name exception", e);
 271             }
 272         }
 273         subnetBuilder.setIpPrefix(subnet.getCidr());
 274         subnetBuilder.setVirtualRouterIp(virtualRouterIp);
 275         return subnetBuilder.build();
 276     }
 277
 278     @Override
 279     public void onUpdated(
 280             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet oldItem,
 281             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet newItem,
 282             Neutron oldNeutron, Neutron newNeutron) {
 283         LOG.trace("updated subnet - {}", newItem);
 284         onCreated(newItem, newNeutron);
 285     }
 286
 287     @Override
 288     public void onDeleted(
 289             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet,
 290             Neutron oldNeutron, Neutron newNeutron) {
 291         LOG.trace("deleted subnet - {}", neutronSubnet);
 292         ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
 293         NetworkDomainId subnetId = new NetworkDomainId(neutronSubnet.getUuid().getValue());
 294         TenantId tenantId = new TenantId(neutronSubnet.getTenantId().getValue());
 295         Optional<NetworkDomain> potentialSubnetDomain = DataStoreHelper.removeIfExists(LogicalDatastoreType.CONFIGURATION,
 296                 L2L3IidFactory.subnetIid(tenantId, subnetId), rwTx);
 297         if (!potentialSubnetDomain.isPresent()) {
 298             LOG.warn("Illegal state - subnet network domain {} does not exist.", subnetId.getValue());
 299             rwTx.cancel();
 300             return;
 301         }
 302         removeTenantSubnet(tenantId, new SubnetId(subnetId), rwTx);
 303
 304         // TODO remove default gateway EP in case when subnet is in provider physical network
 305
 306         DataStoreHelper.submitToDs(rwTx);
 307     }
 308
 309     @Deprecated
 310     private void removeTenantSubnet(TenantId tenantId, SubnetId subnetId, ReadWriteTransaction rwTx) {
 311         Optional<Subnet> potentialSubnet = DataStoreHelper.removeIfExists(LogicalDatastoreType.CONFIGURATION,
 312                 IidFactory.subnetIid(tenantId, subnetId), rwTx);
 313         if (!potentialSubnet.isPresent()) {
 314             LOG.warn("Illegal state - subnet {} does not exist.", subnetId.getValue());
 315             rwTx.cancel();
 316             return;
 317         }
 318     }
 319 }