neutron-mapper/src/main/java/org/opendaylight/groupbasedpolicy/neutron/mapper/NeutronMapper.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;
   9
  10 import java.util.ArrayList;
  11 import java.util.Collection;
  12 import java.util.List;
  13 import java.util.Set;
  14
  15 import javax.annotation.Nonnull;
  16 import javax.annotation.Nullable;
  17
  18 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  19 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  20 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  21 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
  22 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  23 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronAware;
  26 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronFloatingIpAware;
  27 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronNetworkAware;
  28 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronPortAware;
  29 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronRouterAware;
  30 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronSecurityGroupAware;
  31 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronSubnetAware;
  32 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.rule.NeutronSecurityRuleAware;
  33 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
  34 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.NetworkUtils;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.BaseEndpointService;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.EndpointService;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.DirectionEgress;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.DirectionIngress;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.EthertypeV4;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.EthertypeV6;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.floatingips.attributes.floatingips.Floatingip;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.NeutronBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.SecurityGroups;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.SecurityGroupsBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.security.groups.SecurityGroup;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.security.groups.SecurityGroupBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.rules.attributes.SecurityRules;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.rules.attributes.SecurityRulesBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.rules.attributes.security.rules.SecurityRule;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.rules.attributes.security.rules.SecurityRuleBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
  58 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  59 import org.opendaylight.yangtools.yang.binding.DataObject;
  60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  62
  63 import com.google.common.base.Function;
  64 import com.google.common.base.Predicate;
  65 import com.google.common.collect.FluentIterable;
  66 import com.google.common.collect.Iterators;
  67 import com.google.common.collect.PeekingIterator;
  68
  69 public class NeutronMapper implements ClusteredDataTreeChangeListener<Neutron>, AutoCloseable {
  70
  71     private static final String EXC_MSG_UNKNOWN_MODIFICATION_TYPE_WITHIN_DATA = "Unknown modification type within data ";
  72
  73     private final static SecurityRuleBuilder EIG_INGRESS_IPV4_SEC_RULE_BUILDER = new SecurityRuleBuilder()
  74         .setUuid(new Uuid("0a629f80-2408-11e6-b67b-9e71128cae77"))
  75         .setDirection(DirectionIngress.class)
  76         .setEthertype(EthertypeV4.class)
  77         .setSecurityGroupId(MappingUtils.EIG_UUID);
  78     private final static SecurityRuleBuilder EIG_EGRESS_IPV4_SEC_RULE_BUILDER = new SecurityRuleBuilder()
  79         .setUuid(new Uuid("0f1789be-2408-11e6-b67b-9e71128cae77"))
  80         .setDirection(DirectionEgress.class)
  81         .setEthertype(EthertypeV4.class)
  82         .setSecurityGroupId(MappingUtils.EIG_UUID);
  83     private final static SecurityRuleBuilder EIG_INGRESS_IPV6_SEC_RULE_BUILDER = new SecurityRuleBuilder()
  84         .setUuid(new Uuid("139b7f90-2408-11e6-b67b-9e71128cae77"))
  85         .setDirection(DirectionIngress.class)
  86         .setEthertype(EthertypeV6.class)
  87         .setSecurityGroupId(MappingUtils.EIG_UUID);
  88     private final static SecurityRuleBuilder EIG_EGRESS_IPV6_SEC_RULE_BUILDER = new SecurityRuleBuilder()
  89         .setUuid(new Uuid("17517202-2408-11e6-b67b-9e71128cae77"))
  90         .setDirection(DirectionEgress.class)
  91         .setEthertype(EthertypeV6.class)
  92         .setSecurityGroupId(MappingUtils.EIG_UUID);
  93     private final static SecurityGroupBuilder EIG_SEC_GROUP_BUILDER =
  94             new SecurityGroupBuilder().setUuid(MappingUtils.EIG_UUID);
  95
  96     private final NeutronNetworkAware networkAware;
  97     private final NeutronSecurityGroupAware securityGroupAware;
  98     private final NeutronSecurityRuleAware securityRuleAware;
  99     private final NeutronSubnetAware subnetAware;
 100     private final NeutronPortAware portAware;
 101     private final NeutronRouterAware routerAware;
 102     private final NeutronFloatingIpAware floatingIpAware;
 103
 104     private final ListenerRegistration<NeutronMapper> registerDataTreeChangeListener;
 105     private Neutron neutronBefore;
 106     private Neutron neutronAfter;
 107
 108     public NeutronMapper(DataBroker dataProvider, EndpointService epService, BaseEndpointService baseEpService,
 109         @Nullable IpPrefix metadataIpPrefix, long metadataTcpPort) {
 110         EndpointRegistrator epRegistrator = new EndpointRegistrator(epService, baseEpService);
 111         networkAware = new NeutronNetworkAware(dataProvider, metadataTcpPort);
 112         securityRuleAware = new NeutronSecurityRuleAware(dataProvider, epRegistrator);
 113         securityGroupAware = new NeutronSecurityGroupAware(dataProvider, securityRuleAware);
 114         subnetAware = new NeutronSubnetAware(dataProvider, epRegistrator);
 115         portAware = new NeutronPortAware(dataProvider, epRegistrator, metadataIpPrefix);
 116         routerAware = new NeutronRouterAware(dataProvider, epRegistrator);
 117         floatingIpAware = new NeutronFloatingIpAware(dataProvider);
 118         registerDataTreeChangeListener =
 119                 dataProvider.registerDataTreeChangeListener(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 120                         InstanceIdentifier.builder(Neutron.class).build()), this);
 121     }
 122
 123     @Override
 124     public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<Neutron>> changes) {
 125         for (DataTreeModification<Neutron> change : changes) {
 126             DataObjectModification<Neutron> neutronModif = change.getRootNode();
 127             resolveAndSetNeutron(neutronModif);
 128             // network
 129             List<DataObjectModification<Network>> networkModifs =
 130                     findModifiedData(NeutronNetworkAware.NETWORK_WILDCARD_IID, neutronModif);
 131             for (Uuid tenantFromCreatedRouterExternalNetwork : filterCreatedRouterExternalNetworksAndTransformToTenants(
 132                     networkModifs)) {
 133                 SecurityGroup eigSecGroup =
 134                         EIG_SEC_GROUP_BUILDER.setTenantId(tenantFromCreatedRouterExternalNetwork).build();
 135                 securityGroupAware.onCreated(eigSecGroup, neutronAfter);
 136                 List<SecurityRule> eigSecRules = createEigSecurityRules(tenantFromCreatedRouterExternalNetwork);
 137                 for (SecurityRule eigSecRule : eigSecRules) {
 138                     securityRuleAware.onCreated(eigSecRule, neutronAfter);
 139                 }
 140             }
 141             onDataObjectModification(networkModifs, networkAware);
 142             // security group
 143             List<DataObjectModification<SecurityGroup>> secGroupModifs =
 144                     findModifiedData(NeutronSecurityGroupAware.SECURITY_GROUP_WILDCARD_IID, neutronModif);
 145             onDataObjectModification(secGroupModifs, securityGroupAware);
 146             // security rules
 147             List<DataObjectModification<SecurityRule>> secRuleModifs =
 148                     findModifiedData(NeutronSecurityRuleAware.SECURITY_RULE_WILDCARD_IID, neutronModif);
 149             onDataObjectModification(secRuleModifs, securityRuleAware);
 150             // subnet
 151             List<DataObjectModification<Subnet>> subnetModifs = findModifiedData(NeutronSubnetAware.SUBNET_WILDCARD_IID, neutronModif);
 152             onDataObjectModification(subnetModifs, subnetAware);
 153             // port
 154             List<DataObjectModification<Port>> portModifs = findModifiedData(NeutronPortAware.PORT_WILDCARD_IID, neutronModif);
 155             onDataObjectModification(portModifs, portAware);
 156             // router
 157             List<DataObjectModification<Router>> routerModifs = findModifiedData(NeutronRouterAware.ROUTER_WILDCARD_IID, neutronModif);
 158             onDataObjectModification(routerModifs, routerAware);
 159             // floating IP
 160             List<DataObjectModification<Floatingip>> floatingIpModifs = findModifiedData(NeutronFloatingIpAware.FLOATING_IP_WILDCARD_IID, neutronModif);
 161             onDataObjectModification(floatingIpModifs, floatingIpAware);
 162         }
 163     }
 164
 165     private <T extends DataObject> void onDataObjectModification(List<DataObjectModification<T>> dataModifs,
 166             NeutronAware<T> neutronAware) {
 167         for (DataObjectModification<T> dataModif : dataModifs) {
 168             final T dataBefore = dataModif.getDataBefore();
 169             final T dataAfter = dataModif.getDataAfter();
 170             if (dataBefore == null && dataAfter != null) {
 171                 neutronAware.onCreated(dataAfter, neutronAfter);
 172             }
 173             else if (dataBefore != null && dataAfter != null) {
 174                 neutronAware.onUpdated(dataBefore, dataAfter, neutronBefore, neutronAfter);
 175             }
 176             else if (dataBefore != null) {
 177                 neutronAware.onDeleted(dataBefore, neutronBefore, neutronAfter);
 178             }
 179             else {
 180                 throw new IllegalStateException(EXC_MSG_UNKNOWN_MODIFICATION_TYPE_WITHIN_DATA + dataModif);
 181             }
 182         }
 183     }
 184
 185     private Set<Uuid> filterCreatedRouterExternalNetworksAndTransformToTenants(
 186             List<DataObjectModification<Network>> modifiedNetworks) {
 187         return FluentIterable.from(modifiedNetworks).filter(new Predicate<DataObjectModification<Network>>() {
 188
 189             @Override
 190             public boolean apply(DataObjectModification<Network> modifiedNetwork) {
 191                 return (ModificationType.WRITE == modifiedNetwork.getModificationType()
 192                         && NetworkUtils.isRouterExternal(modifiedNetwork.getDataAfter()));
 193             }
 194         }).transform(new Function<DataObjectModification<Network>, Uuid>() {
 195
 196             @Override
 197             public Uuid apply(DataObjectModification<Network> modifiedNetwork) {
 198                 return modifiedNetwork.getDataAfter().getTenantId();
 199             }
 200         }).toSet();
 201     }
 202
 203     private void resolveAndSetNeutron(DataObjectModification<Neutron> originalNeutron) {
 204         Neutron oldNeutronBefore = originalNeutron.getDataBefore();
 205         neutronBefore = resolveAndCreateNewNeutron(oldNeutronBefore);
 206         Neutron oldNeutronAfter = originalNeutron.getDataAfter();
 207         neutronAfter = resolveAndCreateNewNeutron(oldNeutronAfter);
 208     }
 209
 210     private @Nullable Neutron resolveAndCreateNewNeutron(@Nullable Neutron originalNeutron) {
 211         if (originalNeutron == null) {
 212             return null;
 213         }
 214         NeutronBuilder newNeutronBuilder = new NeutronBuilder(originalNeutron);
 215         resolveAndAddSecurityRulesAndGroups(originalNeutron, newNeutronBuilder);
 216         return newNeutronBuilder.build();
 217     }
 218
 219     private void resolveAndAddSecurityRulesAndGroups(Neutron originalNeutron, NeutronBuilder newNeutronBuilder) {
 220         List<SecurityRule> eigSecRulesAndOriginalSecRules = new ArrayList<>();
 221         List<SecurityGroup> eigSecGroupAndOriginalSecGroup = new ArrayList<>();
 222         // resolve EIG sec rules and groups
 223         List<Network> routerExternalNetworks = NetworkUtils.findRouterExternalNetworks(originalNeutron.getNetworks());
 224         Set<Uuid> tenantsFromRouterExternalNetwork = resolveTenantsFromNetworks(routerExternalNetworks);
 225         for (Uuid tenantFromRouterExternalNetwork : tenantsFromRouterExternalNetwork) {
 226             eigSecRulesAndOriginalSecRules.addAll(createEigSecurityRules(tenantFromRouterExternalNetwork));
 227             eigSecGroupAndOriginalSecGroup
 228                 .add(EIG_SEC_GROUP_BUILDER.setTenantId(tenantFromRouterExternalNetwork).build());
 229         }
 230         // set new sec rules
 231         SecurityRules newSecRules = null;
 232         if (originalNeutron.getSecurityRules() != null) {
 233             List<SecurityRule> originalSecRules = originalNeutron.getSecurityRules().getSecurityRule();
 234             if (originalSecRules != null) {
 235                 eigSecRulesAndOriginalSecRules.addAll(originalSecRules);
 236             }
 237             newSecRules = new SecurityRulesBuilder(originalNeutron.getSecurityRules())
 238                 .setSecurityRule(eigSecRulesAndOriginalSecRules).build();
 239         } else {
 240             newSecRules = new SecurityRulesBuilder().setSecurityRule(eigSecRulesAndOriginalSecRules).build();
 241         }
 242         newNeutronBuilder.setSecurityRules(newSecRules);
 243         // set new sec groups
 244         SecurityGroups newSecGroups = null;
 245         if (originalNeutron.getSecurityGroups() != null) {
 246             List<SecurityGroup> originalSecGroups = originalNeutron.getSecurityGroups().getSecurityGroup();
 247             if (originalSecGroups != null) {
 248                 eigSecGroupAndOriginalSecGroup.addAll(originalSecGroups);
 249             }
 250             newSecGroups = new SecurityGroupsBuilder(originalNeutron.getSecurityGroups())
 251                 .setSecurityGroup(eigSecGroupAndOriginalSecGroup).build();
 252         } else {
 253             newSecGroups = new SecurityGroupsBuilder().setSecurityGroup(eigSecGroupAndOriginalSecGroup).build();
 254         }
 255         newNeutronBuilder.setSecurityGroups(newSecGroups);
 256     }
 257
 258     private Set<Uuid> resolveTenantsFromNetworks(List<Network> networks) {
 259         return FluentIterable.from(networks).transform(new Function<Network, Uuid>() {
 260
 261             @Override
 262             public Uuid apply(Network network) {
 263                 return network.getTenantId();
 264             }
 265         }).toSet();
 266     }
 267
 268     private List<SecurityRule> createEigSecurityRules(Uuid tenant) {
 269         List<SecurityRule> eigSecRules = new ArrayList<>();
 270         eigSecRules.add(EIG_INGRESS_IPV4_SEC_RULE_BUILDER.setTenantId(tenant).build());
 271         eigSecRules.add(EIG_EGRESS_IPV4_SEC_RULE_BUILDER.setTenantId(tenant).build());
 272         eigSecRules.add(EIG_INGRESS_IPV6_SEC_RULE_BUILDER.setTenantId(tenant).build());
 273         eigSecRules.add(EIG_EGRESS_IPV6_SEC_RULE_BUILDER.setTenantId(tenant).build());
 274         return eigSecRules;
 275     }
 276
 277     /**
 278      * Finds all modified subnodes of given type in {@link Neutron} node.
 279      *
 280      * @param <T>
 281      * @param iid path to data in root node
 282      * @param rootNode modified data of {@link Neutron} node
 283      * @return {@link List} of modified subnodes
 284      */
 285     private <T extends DataObject> List<DataObjectModification<T>> findModifiedData(InstanceIdentifier<T> iid,
 286             DataObjectModification<Neutron> rootNode) {
 287         List<DataObjectModification<T>> modDtos = new ArrayList<>();
 288         PeekingIterator<PathArgument> pathArgs = Iterators.peekingIterator(iid.getPathArguments().iterator());
 289         DataObjectModification<? extends DataObject> modifDto = rootNode;
 290         while (pathArgs.hasNext()) {
 291             pathArgs.next();
 292             for (DataObjectModification<? extends DataObject> childDto : modifDto.getModifiedChildren()) {
 293                 if (pathArgs.hasNext() && childDto.getDataType().equals(pathArgs.peek().getType())) {
 294                     if (childDto.getDataType().equals(iid.getTargetType())) {
 295                         modDtos.add((DataObjectModification<T>) childDto);
 296                     } else {
 297                         modifDto = childDto;
 298                         break;
 299                     }
 300                 }
 301             }
 302         }
 303         return modDtos;
 304     }
 305
 306     @Override
 307     public void close() {
 308         registerDataTreeChangeListener.close();
 309     }
 310
 311 }