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