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