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.io.IOException;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.Set;
  15
  16 import javax.annotation.Nullable;
  17
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  20 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
  21 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  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.controller.sal.binding.api.RpcProviderRegistry;
  26 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronAware;
  27 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronFloatingIpAware;
  28 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronNetworkAware;
  29 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronPortAware;
  30 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronRouterAware;
  31 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronSecurityGroupAware;
  32 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.NeutronSubnetAware;
  33 import org.opendaylight.groupbasedpolicy.neutron.mapper.mapping.rule.NeutronSecurityRuleAware;
  34 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
  35 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.NetworkUtils;
  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 DataTreeChangeListener<Neutron>, AutoCloseable {
  70
  71     public 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, RpcProviderRegistry rpcProvider) {
 109         EndpointService epService = rpcProvider.getRpcService(EndpointService.class);
 110         BaseEndpointService baseEpService = rpcProvider.getRpcService(BaseEndpointService.class);
 111         EndpointRegistrator epRegistrator = new EndpointRegistrator(epService, baseEpService);
 112         networkAware = new NeutronNetworkAware(dataProvider);
 113         securityGroupAware = new NeutronSecurityGroupAware(dataProvider);
 114         securityRuleAware = new NeutronSecurityRuleAware(dataProvider);
 115         subnetAware = new NeutronSubnetAware(dataProvider, epRegistrator);
 116         portAware = new NeutronPortAware(dataProvider, epRegistrator);
 117         routerAware = new NeutronRouterAware(dataProvider, epRegistrator);
 118         floatingIpAware = new NeutronFloatingIpAware(dataProvider);
 119         registerDataTreeChangeListener =
 120                 dataProvider.registerDataTreeChangeListener(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
 121                         InstanceIdentifier.builder(Neutron.class).build()), this);
 122     }
 123
 124     @Override
 125     public void onDataTreeChanged(Collection<DataTreeModification<Neutron>> changes) {
 126         for (DataTreeModification<Neutron> change : changes) {
 127             DataObjectModification<Neutron> neutronModif = change.getRootNode();
 128             resolveAndSetNeutron(neutronModif);
 129             // network
 130             List<DataObjectModification<Network>> networkModifs =
 131                     findModifiedData(NeutronNetworkAware.NETWORK_WILDCARD_IID, neutronModif);
 132             for (Uuid tenantFromCreatedRouterExternalNetwork : filterCreatedRouterExternalNetworksAndTransformToTenants(
 133                     networkModifs)) {
 134                 SecurityGroup eigSecGroup =
 135                         EIG_SEC_GROUP_BUILDER.setTenantId(tenantFromCreatedRouterExternalNetwork).build();
 136                 securityGroupAware.onCreated(eigSecGroup, neutronAfter);
 137                 List<SecurityRule> eigSecRules = createEigSecurityRules(tenantFromCreatedRouterExternalNetwork);
 138                 for (SecurityRule eigSecRule : eigSecRules) {
 139                     securityRuleAware.onCreated(eigSecRule, neutronAfter);
 140                 }
 141             }
 142             onDataObjectModification(networkModifs, networkAware);
 143             // security group
 144             List<DataObjectModification<SecurityGroup>> secGroupModifs =
 145                     findModifiedData(NeutronSecurityGroupAware.SECURITY_GROUP_WILDCARD_IID, neutronModif);
 146             onDataObjectModification(secGroupModifs, securityGroupAware);
 147             // security rules
 148             List<DataObjectModification<SecurityRule>> secRuleModifs =
 149                     findModifiedData(NeutronSecurityRuleAware.SECURITY_RULE_WILDCARD_IID, neutronModif);
 150             onDataObjectModification(secRuleModifs, securityRuleAware);
 151             // subnet
 152             List<DataObjectModification<Subnet>> subnetModifs = findModifiedData(NeutronSubnetAware.SUBNET_WILDCARD_IID, neutronModif);
 153             onDataObjectModification(subnetModifs, subnetAware);
 154             // port
 155             List<DataObjectModification<Port>> portModifs = findModifiedData(NeutronPortAware.PORT_WILDCARD_IID, neutronModif);
 156             onDataObjectModification(portModifs, portAware);
 157             // router
 158             List<DataObjectModification<Router>> routerModifs = findModifiedData(NeutronRouterAware.ROUTER_WILDCARD_IID, neutronModif);
 159             onDataObjectModification(routerModifs, routerAware);
 160             // floating IP
 161             List<DataObjectModification<Floatingip>> floatingIpModifs = findModifiedData(NeutronFloatingIpAware.FLOATING_IP_WILDCARD_IID, neutronModif);
 162             onDataObjectModification(floatingIpModifs, floatingIpAware);
 163         }
 164     }
 165
 166     private <T extends DataObject> void onDataObjectModification(List<DataObjectModification<T>> dataModifs,
 167             NeutronAware<T> neutronAware) {
 168         for (DataObjectModification<T> dataModif : dataModifs) {
 169             switch (dataModif.getModificationType()) {
 170                 case DELETE:
 171                     neutronAware.onDeleted(dataModif.getDataBefore(), neutronBefore, neutronAfter);
 172                     break;
 173                 case SUBTREE_MODIFIED:
 174                     neutronAware.onUpdated(dataModif.getDataBefore(), dataModif.getDataAfter(), neutronBefore,
 175                             neutronAfter);
 176                     break;
 177                 case WRITE:
 178                     if (dataModif.getDataBefore() == null) {
 179                         neutronAware.onCreated(dataModif.getDataAfter(), neutronAfter);
 180                     } else {
 181                         neutronAware.onUpdated(dataModif.getDataBefore(), dataModif.getDataAfter(), neutronBefore,
 182                                 neutronAfter);
 183                     }
 184                     break;
 185                 default:
 186                     throw new IllegalStateException(EXC_MSG_UNKNOWN_MODIFICATION_TYPE_WITHIN_DATA + dataModif);
 187             }
 188         }
 189     }
 190
 191     private Set<Uuid> filterCreatedRouterExternalNetworksAndTransformToTenants(
 192             List<DataObjectModification<Network>> modifiedNetworks) {
 193         return FluentIterable.from(modifiedNetworks).filter(new Predicate<DataObjectModification<Network>>() {
 194
 195             @Override
 196             public boolean apply(DataObjectModification<Network> modifiedNetwork) {
 197                 return (ModificationType.WRITE == modifiedNetwork.getModificationType()
 198                         && NetworkUtils.isRouterExternal(modifiedNetwork.getDataAfter()));
 199             }
 200         }).transform(new Function<DataObjectModification<Network>, Uuid>() {
 201
 202             @Override
 203             public Uuid apply(DataObjectModification<Network> modifiedNetwork) {
 204                 return modifiedNetwork.getDataAfter().getTenantId();
 205             }
 206         }).toSet();
 207     }
 208
 209     private void resolveAndSetNeutron(DataObjectModification<Neutron> originalNeutron) {
 210         Neutron oldNeutronBefore = originalNeutron.getDataBefore();
 211         neutronBefore = resolveAndCreateNewNeutron(oldNeutronBefore);
 212         Neutron oldNeutronAfter = originalNeutron.getDataAfter();
 213         neutronAfter = resolveAndCreateNewNeutron(oldNeutronAfter);
 214     }
 215
 216     private @Nullable Neutron resolveAndCreateNewNeutron(@Nullable Neutron originalNeutron) {
 217         if (originalNeutron == null) {
 218             return null;
 219         }
 220         NeutronBuilder newNeutronBuilder = new NeutronBuilder(originalNeutron);
 221         resolveAndAddSecurityRulesAndGroups(originalNeutron, newNeutronBuilder);
 222         return newNeutronBuilder.build();
 223     }
 224
 225     private void resolveAndAddSecurityRulesAndGroups(Neutron originalNeutron, NeutronBuilder newNeutronBuilder) {
 226         List<SecurityRule> eigSecRulesAndOriginalSecRules = new ArrayList<>();
 227         List<SecurityGroup> eigSecGroupAndOriginalSecGroup = new ArrayList<>();
 228         // resolve EIG sec rules and groups
 229         List<Network> routerExternalNetworks = NetworkUtils.findRouterExternalNetworks(originalNeutron.getNetworks());
 230         Set<Uuid> tenantsFromRouterExternalNetwork = resolveTenantsFromNetworks(routerExternalNetworks);
 231         for (Uuid tenantFromRouterExternalNetwork : tenantsFromRouterExternalNetwork) {
 232             eigSecRulesAndOriginalSecRules.addAll(createEigSecurityRules(tenantFromRouterExternalNetwork));
 233             eigSecGroupAndOriginalSecGroup
 234                 .add(EIG_SEC_GROUP_BUILDER.setTenantId(tenantFromRouterExternalNetwork).build());
 235         }
 236         // set new sec rules
 237         SecurityRules newSecRules = null;
 238         if (originalNeutron.getSecurityRules() != null) {
 239             List<SecurityRule> originalSecRules = originalNeutron.getSecurityRules().getSecurityRule();
 240             if (originalSecRules != null) {
 241                 eigSecRulesAndOriginalSecRules.addAll(originalSecRules);
 242             }
 243             newSecRules = new SecurityRulesBuilder(originalNeutron.getSecurityRules())
 244                 .setSecurityRule(eigSecRulesAndOriginalSecRules).build();
 245         } else {
 246             newSecRules = new SecurityRulesBuilder().setSecurityRule(eigSecRulesAndOriginalSecRules).build();
 247         }
 248         newNeutronBuilder.setSecurityRules(newSecRules);
 249         // set new sec groups
 250         SecurityGroups newSecGroups = null;
 251         if (originalNeutron.getSecurityGroups() != null) {
 252             List<SecurityGroup> originalSecGroups = originalNeutron.getSecurityGroups().getSecurityGroup();
 253             if (originalSecGroups != null) {
 254                 eigSecGroupAndOriginalSecGroup.addAll(originalSecGroups);
 255             }
 256             newSecGroups = new SecurityGroupsBuilder(originalNeutron.getSecurityGroups())
 257                 .setSecurityGroup(eigSecGroupAndOriginalSecGroup).build();
 258         } else {
 259             newSecGroups = new SecurityGroupsBuilder().setSecurityGroup(eigSecGroupAndOriginalSecGroup).build();
 260         }
 261         newNeutronBuilder.setSecurityGroups(newSecGroups);
 262     }
 263
 264     private Set<Uuid> resolveTenantsFromNetworks(List<Network> networks) {
 265         return FluentIterable.from(networks).transform(new Function<Network, Uuid>() {
 266
 267             @Override
 268             public Uuid apply(Network network) {
 269                 return network.getTenantId();
 270             }
 271         }).toSet();
 272     }
 273
 274     private List<SecurityRule> createEigSecurityRules(Uuid tenant) {
 275         List<SecurityRule> eigSecRules = new ArrayList<>();
 276         eigSecRules.add(EIG_INGRESS_IPV4_SEC_RULE_BUILDER.setTenantId(tenant).build());
 277         eigSecRules.add(EIG_EGRESS_IPV4_SEC_RULE_BUILDER.setTenantId(tenant).build());
 278         eigSecRules.add(EIG_INGRESS_IPV6_SEC_RULE_BUILDER.setTenantId(tenant).build());
 279         eigSecRules.add(EIG_EGRESS_IPV6_SEC_RULE_BUILDER.setTenantId(tenant).build());
 280         return eigSecRules;
 281     }
 282
 283     /**
 284      * Finds all modified subnodes of given type in {@link Neutron} node.
 285      *
 286      * @param <T>
 287      * @param iid path to data in root node
 288      * @param rootNode modified data of {@link Neutron} node
 289      * @return {@link List} of modified subnodes
 290      */
 291     private <T extends DataObject> List<DataObjectModification<T>> findModifiedData(InstanceIdentifier<T> iid,
 292             DataObjectModification<Neutron> rootNode) {
 293         List<DataObjectModification<T>> modDtos = new ArrayList<>();
 294         PeekingIterator<PathArgument> pathArgs = Iterators.peekingIterator(iid.getPathArguments().iterator());
 295         DataObjectModification<? extends DataObject> modifDto = rootNode;
 296         while (pathArgs.hasNext()) {
 297             pathArgs.next();
 298             for (DataObjectModification<? extends DataObject> childDto : modifDto.getModifiedChildren()) {
 299                 if (pathArgs.hasNext() && childDto.getDataType().equals(pathArgs.peek().getType())) {
 300                     if (childDto.getDataType().equals(iid.getTargetType())) {
 301                         modDtos.add((DataObjectModification<T>) childDto);
 302                     } else {
 303                         modifDto = childDto;
 304                         break;
 305                     }
 306                 }
 307             }
 308         }
 309         return modDtos;
 310     }
 311
 312     @Override
 313     public void close() throws IOException {
 314         registerDataTreeChangeListener.close();
 315     }
 316
 317 }