aclservice/impl/src/main/java/org/opendaylight/netvirt/aclservice/listeners/AclInterfaceStateListener.java

   1 /*
   2  * Copyright (c) 2016 Red Hat, 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.netvirt.aclservice.listeners;
   9
  10 import java.util.Collections;
  11 import java.util.List;
  12 import java.util.SortedSet;
  13 import javax.annotation.PostConstruct;
  14 import javax.inject.Inject;
  15 import javax.inject.Singleton;
  16 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  20 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  21 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  22 import org.opendaylight.netvirt.aclservice.api.AclInterfaceCache;
  23 import org.opendaylight.netvirt.aclservice.api.AclServiceManager;
  24 import org.opendaylight.netvirt.aclservice.api.AclServiceManager.Action;
  25 import org.opendaylight.netvirt.aclservice.api.utils.AclInterface;
  26 import org.opendaylight.netvirt.aclservice.utils.AclClusterUtil;
  27 import org.opendaylight.netvirt.aclservice.utils.AclDataUtil;
  28 import org.opendaylight.netvirt.aclservice.utils.AclServiceUtils;
  29 import org.opendaylight.serviceutils.srm.RecoverableListener;
  30 import org.opendaylight.serviceutils.srm.ServiceRecoveryRegistry;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev170119.L2vlan;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.DirectionEgress;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.DirectionIngress;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.aclservice.rev160608.InterfaceAcl;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 @Singleton
  43 public class AclInterfaceStateListener extends AsyncDataTreeChangeListenerBase<Interface,
  44         AclInterfaceStateListener> implements ClusteredDataTreeChangeListener<Interface>, RecoverableListener {
  45
  46     private static final Logger LOG = LoggerFactory.getLogger(AclInterfaceStateListener.class);
  47
  48     /** Our registration. */
  49     private final AclServiceManager aclServiceManger;
  50     private final AclClusterUtil aclClusterUtil;
  51     private final DataBroker dataBroker;
  52     private final AclDataUtil aclDataUtil;
  53     private final IInterfaceManager interfaceManager;
  54     private final AclInterfaceCache aclInterfaceCache;
  55     private final AclServiceUtils aclServiceUtils;
  56     protected final JobCoordinator jobCoordinator;
  57
  58     @Inject
  59     public AclInterfaceStateListener(AclServiceManager aclServiceManger, AclClusterUtil aclClusterUtil,
  60             DataBroker dataBroker, AclDataUtil aclDataUtil, IInterfaceManager interfaceManager,
  61             AclInterfaceCache aclInterfaceCache, AclServiceUtils aclServicUtils, JobCoordinator jobCoordinator,
  62             ServiceRecoveryRegistry serviceRecoveryRegistry) {
  63         super(Interface.class, AclInterfaceStateListener.class);
  64         this.aclServiceManger = aclServiceManger;
  65         this.aclClusterUtil = aclClusterUtil;
  66         this.dataBroker = dataBroker;
  67         this.aclDataUtil = aclDataUtil;
  68         this.interfaceManager = interfaceManager;
  69         this.aclInterfaceCache = aclInterfaceCache;
  70         this.aclServiceUtils = aclServicUtils;
  71         this.jobCoordinator = jobCoordinator;
  72         serviceRecoveryRegistry.addRecoverableListener(AclServiceUtils.getRecoverServiceRegistryKey(), this);
  73     }
  74
  75     @Override
  76     @PostConstruct
  77     public void init() {
  78         LOG.info("{} start", getClass().getSimpleName());
  79         registerListener();
  80     }
  81
  82     @Override
  83     public void registerListener() {
  84         registerListener(LogicalDatastoreType.OPERATIONAL, dataBroker);
  85     }
  86
  87     @Override
  88     protected InstanceIdentifier<Interface> getWildCardPath() {
  89         return InstanceIdentifier.create(InterfacesState.class).child(Interface.class);
  90     }
  91
  92     @Override
  93     protected void remove(InstanceIdentifier<Interface> key, Interface deleted) {
  94         if (!L2vlan.class.equals(deleted.getType())) {
  95             return;
  96         }
  97         String interfaceId = deleted.getName();
  98         AclInterface aclInterface = aclInterfaceCache.remove(interfaceId);
  99         if (AclServiceUtils.isOfInterest(aclInterface)) {
 100             List<Uuid> aclList = aclInterface.getSecurityGroups();
 101             if (aclClusterUtil.isEntityOwner()) {
 102                 LOG.debug("On remove event, notify ACL service manager to remove ACL from interface: {}", aclInterface);
 103                 aclServiceManger.notify(aclInterface, null, Action.UNBIND);
 104                 aclServiceManger.notify(aclInterface, null, Action.REMOVE);
 105
 106                 if (aclList != null) {
 107                     aclServiceUtils.deleteAclPortsLookup(aclInterface, aclList, aclInterface.getAllowedAddressPairs());
 108                 }
 109             }
 110             if (aclList != null) {
 111                 for (Uuid acl : aclList) {
 112                     jobCoordinator.enqueueJob(acl.getValue(), () -> {
 113                         aclDataUtil.removeAclInterfaceMap(acl, aclInterface);
 114                         return Collections.emptyList();
 115                     });
 116                 }
 117             }
 118         }
 119     }
 120
 121     @Override
 122     protected void update(InstanceIdentifier<Interface> key, Interface before, Interface after) {
 123         /*
 124          * The update is not of interest as the attributes populated from this listener will not change.
 125          * The northbound updates are handled in AclInterfaceListener.
 126          *
 127          * We're only interested in update in cases where IfType got filled after creation.
 128          */
 129         if (before.getType() == null && L2vlan.class.equals(after.getType())) {
 130             add(key, after);
 131         } else {
 132             LOG.trace("Update event for AclInterfaceStateListener is not of interest.");
 133         }
 134     }
 135
 136     @Override
 137     protected void add(InstanceIdentifier<Interface> key, Interface added) {
 138         if (!L2vlan.class.equals(added.getType())) {
 139             return;
 140         }
 141
 142         if (aclInterfaceCache.get(added.getName()) == null) {
 143             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 144                         .Interface iface = interfaceManager.getInterfaceInfoFromConfigDataStore(added.getName());
 145             if (iface == null) {
 146                 LOG.error("No interface with name {} available in interfaceConfig, servicing interfaceState ADD"
 147                         + "for ACL failed", added.getName());
 148                 return;
 149             }
 150             InterfaceAcl aclInPort = iface.augmentation(InterfaceAcl.class);
 151             if (aclInPort == null) {
 152                 LOG.trace("Interface {} is not an ACL Interface, ignoring ADD interfaceState event",
 153                         added.getName());
 154                 return;
 155             }
 156             aclInterfaceCache.addOrUpdate(added.getName(), (prevAclInterface, builder) -> {
 157                 builder.portSecurityEnabled(aclInPort.isPortSecurityEnabled())
 158                     .securityGroups(aclInPort.getSecurityGroups())
 159                     .allowedAddressPairs(aclInPort.getAllowedAddressPairs()).subnetInfo(aclInPort.getSubnetInfo());
 160             });
 161         }
 162         AclInterface aclInterface = aclInterfaceCache.addOrUpdate(added.getName(), (prevAclInterface, builder) -> {
 163             builder.dpId(AclServiceUtils.getDpIdFromIterfaceState(added)).lPortTag(added.getIfIndex())
 164                 .isMarkedForDelete(false);
 165             if (AclServiceUtils.isOfInterest(prevAclInterface)) {
 166                 SortedSet<Integer> ingressRemoteAclTags =
 167                         aclServiceUtils.getRemoteAclTags(prevAclInterface.getSecurityGroups(), DirectionIngress.class);
 168                 SortedSet<Integer> egressRemoteAclTags =
 169                         aclServiceUtils.getRemoteAclTags(prevAclInterface.getSecurityGroups(), DirectionEgress.class);
 170                 builder.ingressRemoteAclTags(ingressRemoteAclTags).egressRemoteAclTags(egressRemoteAclTags);
 171             }
 172         });
 173
 174         if (AclServiceUtils.isOfInterest(aclInterface)) {
 175             List<Uuid> aclList = aclInterface.getSecurityGroups();
 176             if (aclList != null) {
 177                 aclDataUtil.addOrUpdateAclInterfaceMap(aclList, aclInterface);
 178             }
 179             if (aclInterface.getElanId() == null) {
 180                 LOG.debug("On Add event, skip ADD since ElanId is not updated");
 181                 return;
 182             }
 183             if (aclClusterUtil.isEntityOwner()) {
 184                 LOG.debug("On add event, notify ACL service manager to add ACL for interface: {}", aclInterface);
 185                 aclServiceManger.notify(aclInterface, null, Action.BIND);
 186                 if (aclList != null) {
 187                     aclServiceUtils.addAclPortsLookup(aclInterface, aclList, aclInterface.getAllowedAddressPairs());
 188                 }
 189                 aclServiceManger.notify(aclInterface, null, Action.ADD);
 190             }
 191         }
 192     }
 193
 194     @Override
 195     protected AclInterfaceStateListener getDataTreeChangeListener() {
 196         return AclInterfaceStateListener.this;
 197     }
 198 }