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 org.opendaylight.controller.md.sal.binding.api.DataBroker;
  13 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  15 import org.opendaylight.groupbasedpolicy.domain_extension.l2_l3.util.L2L3IidFactory;
  16 import org.opendaylight.groupbasedpolicy.neutron.mapper.EndpointRegistrator;
  17 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
  18 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.NetworkUtils;
  19 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.Utils;
  20 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
  21 import org.opendaylight.groupbasedpolicy.util.IidFactory;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContextId;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Name;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.NetworkDomainId;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubnetId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.L2FloodDomain;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.SubnetAugmentForwarding;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.SubnetAugmentForwardingBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.has.subnet.SubnetBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.forwarding.by.tenant.NetworkDomain;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.forwarding.by.tenant.NetworkDomainBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.Subnet;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 import com.google.common.base.Optional;
  44 import com.google.common.base.Strings;
  45
  46 public class NeutronSubnetAware implements
  47         NeutronAware<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet> {
  48
  49     private final static Logger LOG = LoggerFactory.getLogger(NeutronSubnetAware.class);
  50     public static final InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet> SUBNET_WILDCARD_IID =
  51             InstanceIdentifier.builder(Neutron.class)
  52                 .child(Subnets.class)
  53                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet.class)
  54                 .build();
  55     private final DataBroker dataProvider;
  56     private final EndpointRegistrator epRegistrator;
  57
  58     public NeutronSubnetAware(DataBroker dataProvider, EndpointRegistrator epRegistrator) {
  59         this.dataProvider = checkNotNull(dataProvider);
  60         this.epRegistrator = checkNotNull(epRegistrator);
  61     }
  62
  63     @Override
  64     public void onCreated(
  65             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet,
  66             Neutron neutron) {
  67         LOG.trace("created subnet - {}", neutronSubnet);
  68         ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
  69         TenantId tenantId = new TenantId(neutronSubnet.getTenantId().getValue());
  70
  71         Optional<Network> potentialNetwork =
  72                 NetworkUtils.findNetwork(neutronSubnet.getNetworkId(), neutron.getNetworks());
  73         if (!potentialNetwork.isPresent()) {
  74             LOG.warn("Illegal state - network {} does not exist for subnet {}.",
  75                     neutronSubnet.getNetworkId().getValue(), neutronSubnet);
  76             rwTx.cancel();
  77             return;
  78         }
  79
  80         Network networkOfSubnet = potentialNetwork.get();
  81
  82         NetworkDomain subnetDomain = null;
  83         if (NetworkUtils.isProviderPhysicalNetwork(networkOfSubnet)) {
  84             // add virtual router IP only in case it is provider physical network
  85             subnetDomain = createSubnet(neutronSubnet, neutronSubnet.getGatewayIp());
  86             IpAddress gatewayIp = neutronSubnet.getGatewayIp();
  87             boolean registeredDefaultRoute = epRegistrator.registerExternalL3PrefixEndpoint(MappingUtils.DEFAULT_ROUTE,
  88                     new L3ContextId(neutronSubnet.getNetworkId().getValue()), gatewayIp, tenantId);
  89             if (!registeredDefaultRoute) {
  90                 LOG.warn("Could not add EndpointL3Prefix as default route. Subnet within provider physical network {}",
  91                         neutronSubnet);
  92                 rwTx.cancel();
  93                 return;
  94             }
  95         } else {
  96             // virtual router IP is not set and it will be set when router gateway port is set
  97             // or when a router port is attached to a network
  98             subnetDomain = createSubnet(neutronSubnet, null);
  99         }
 100         processTenantSubnet(neutronSubnet, networkOfSubnet, tenantId, rwTx);
 101         rwTx.put(LogicalDatastoreType.CONFIGURATION, L2L3IidFactory.subnetIid(tenantId, subnetDomain.getNetworkDomainId()), subnetDomain, true);
 102         DataStoreHelper.submitToDs(rwTx);
 103     }
 104
 105     public static NetworkDomain createSubnet(
 106             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet,
 107             IpAddress virtualRouterIp) {
 108         SubnetBuilder sb = new SubnetBuilder();
 109         sb.setIpPrefix(Utils.createIpPrefix(subnet.getCidr()));
 110         sb.setVirtualRouterIp(virtualRouterIp);
 111         NetworkDomainBuilder ndb = new NetworkDomainBuilder();
 112         if (!Strings.isNullOrEmpty(subnet.getName())) {
 113             try {
 114                 ndb.setName(new Name(subnet.getName()));
 115             } catch (Exception e) {
 116                 LOG.info("Name '{}' of Neutron Subnet '{}' is ignored.", subnet.getName(), subnet.getUuid().getValue());
 117                 LOG.debug("Name exception", e);
 118             }
 119         }
 120         ndb.setNetworkDomainId(new NetworkDomainId(subnet.getUuid().getValue()));
 121         ndb.setNetworkDomainType(MappingUtils.SUBNET);
 122         ndb.setParent(MappingUtils.createParent(new NetworkDomainId(subnet.getUuid().getValue()), L2FloodDomain.class));
 123         ndb.addAugmentation(SubnetAugmentForwarding.class, new SubnetAugmentForwardingBuilder().setSubnet(sb.build())
 124             .build());
 125         return ndb.build();
 126     }
 127
 128     @Deprecated
 129     private void processTenantSubnet(org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet, Network networkOfSubnet, TenantId tenantId, ReadWriteTransaction rwTx) {
 130         Subnet subnet = null;
 131         if (NetworkUtils.isProviderPhysicalNetwork(networkOfSubnet)) {
 132             // add virtual router IP only in case it is provider physical network
 133             subnet = createTenantSubnet(neutronSubnet, neutronSubnet.getGatewayIp());
 134             IpAddress gatewayIp = neutronSubnet.getGatewayIp();
 135             boolean registeredDefaultRoute = epRegistrator.registerExternalL3PrefixEndpoint(MappingUtils.DEFAULT_ROUTE,
 136                     new L3ContextId(neutronSubnet.getNetworkId().getValue()), gatewayIp, tenantId);
 137             if (!registeredDefaultRoute) {
 138                 LOG.warn("Could not add EndpointL3Prefix as default route. Subnet within provider physical network {}",
 139                         neutronSubnet);
 140                 rwTx.cancel();
 141                 return;
 142             }
 143         } else {
 144             // virtual router IP is not set and it will be set when router gateway port is set
 145             // or when a router port is attached to a network
 146             subnet = createTenantSubnet(neutronSubnet, null);
 147         }
 148         rwTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.subnetIid(tenantId, subnet.getId()), subnet, true);
 149     }
 150
 151     @Deprecated
 152     public static Subnet createTenantSubnet(
 153             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet subnet,
 154             IpAddress virtualRouterIp) {
 155         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();
 156         subnetBuilder.setId(new SubnetId(subnet.getUuid().getValue()));
 157         subnetBuilder.setParent(new ContextId(subnet.getNetworkId().getValue()));
 158         if (!Strings.isNullOrEmpty(subnet.getName())) {
 159             try {
 160                 subnetBuilder.setName(new Name(subnet.getName()));
 161             } catch (Exception e) {
 162                 LOG.info("Name '{}' of Neutron Subnet '{}' is ignored.", subnet.getName(),
 163                         subnet.getUuid().getValue());
 164                 LOG.debug("Name exception", e);
 165             }
 166         }
 167         subnetBuilder.setIpPrefix(Utils.createIpPrefix(subnet.getCidr()));
 168         subnetBuilder.setVirtualRouterIp(virtualRouterIp);
 169         return subnetBuilder.build();
 170     }
 171
 172     @Override
 173     public void onUpdated(
 174             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet oldItem,
 175             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet newItem,
 176             Neutron oldNeutron, Neutron newNeutron) {
 177         LOG.trace("updated subnet - {}", newItem);
 178         onCreated(newItem, newNeutron);
 179     }
 180
 181     @Override
 182     public void onDeleted(
 183             org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet neutronSubnet,
 184             Neutron oldNeutron, Neutron newNeutron) {
 185         LOG.trace("deleted subnet - {}", neutronSubnet);
 186         ReadWriteTransaction rwTx = dataProvider.newReadWriteTransaction();
 187         NetworkDomainId subnetId = new NetworkDomainId(neutronSubnet.getUuid().getValue());
 188         TenantId tenantId = new TenantId(neutronSubnet.getTenantId().getValue());
 189         Optional<NetworkDomain> potentialSubnetDomain = DataStoreHelper.removeIfExists(LogicalDatastoreType.CONFIGURATION,
 190                 L2L3IidFactory.subnetIid(tenantId, subnetId), rwTx);
 191         if (!potentialSubnetDomain.isPresent()) {
 192             LOG.warn("Illegal state - subnet network domain {} does not exist.", subnetId.getValue());
 193             rwTx.cancel();
 194             return;
 195         }
 196         removeTenantSubnet(tenantId, new SubnetId(subnetId), rwTx);
 197
 198         // TODO remove default gateway EP in case when subnet is in provider physical network
 199
 200         DataStoreHelper.submitToDs(rwTx);
 201     }
 202
 203     @Deprecated
 204     private void removeTenantSubnet(TenantId tenantId, SubnetId subnetId, ReadWriteTransaction rwTx) {
 205         Optional<Subnet> potentialSubnet = DataStoreHelper.removeIfExists(LogicalDatastoreType.CONFIGURATION,
 206                 IidFactory.subnetIid(tenantId, subnetId), rwTx);
 207         if (!potentialSubnet.isPresent()) {
 208             LOG.warn("Illegal state - subnet {} does not exist.", subnetId.getValue());
 209             rwTx.cancel();
 210             return;
 211         }
 212     }
 213 }