policyservice/impl/src/main/java/org/opendaylight/netvirt/policyservice/listeners/PolicyAceChangeListener.java

   1 /*
   2  * Copyright (c) 2017 Hewlett Packard Enterprise, Co. 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
   9 package org.opendaylight.netvirt.policyservice.listeners;
  10
  11 import com.google.common.base.Optional;
  12 import java.math.BigInteger;
  13 import java.util.List;
  14 import javax.annotation.PostConstruct;
  15 import javax.inject.Inject;
  16 import javax.inject.Singleton;
  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.mdsalutil.NwConstants;
  21 import org.opendaylight.netvirt.policyservice.PolicyAceFlowProgrammer;
  22 import org.opendaylight.netvirt.policyservice.util.PolicyServiceUtil;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.AccessLists;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.AclKey;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.AccessListEntries;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.ace.Matches;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 /**
  34  * Listen on policy ACL {@link Ace} config changes and update the
  35  * POLICY_CLASSIFER_TABLE accordingly.<br>
  36  * Each valid policy ACE contains a set of {@link Matches} associated to
  37  * policy-classifier. The policy classifier is coded using write_metadata
  38  * instruction with METADATA_MASK_POLICY_CLASSIFER_ID mask
  39  *
  40  */
  41 @Singleton
  42 public class PolicyAceChangeListener extends AsyncDataTreeChangeListenerBase<Ace, PolicyAceChangeListener> {
  43     private static final Logger LOG = LoggerFactory.getLogger(PolicyAceChangeListener.class);
  44
  45     private final DataBroker dataBroker;
  46     private final PolicyServiceUtil policyServiceUtil;
  47     private final PolicyAceFlowProgrammer aceFlowProgrammer;
  48
  49     @Inject
  50     public PolicyAceChangeListener(final DataBroker dataBroker, final PolicyServiceUtil policyServiceUtil,
  51             final PolicyAceFlowProgrammer aceFlowProgrammer) {
  52         this.dataBroker = dataBroker;
  53         this.policyServiceUtil = policyServiceUtil;
  54         this.aceFlowProgrammer = aceFlowProgrammer;
  55     }
  56
  57     @Override
  58     @PostConstruct
  59     public void init() {
  60         LOG.info("init");
  61         registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
  62     }
  63
  64     @Override
  65     protected InstanceIdentifier<Ace> getWildCardPath() {
  66         return InstanceIdentifier.create(AccessLists.class).child(Acl.class).child(AccessListEntries.class)
  67                 .child(Ace.class);
  68     }
  69
  70     @Override
  71     protected PolicyAceChangeListener getDataTreeChangeListener() {
  72         return this;
  73     }
  74
  75     @Override
  76     protected void remove(InstanceIdentifier<Ace> identifier, Ace ace) {
  77         handlePolicyAceUpdate(identifier.firstKeyOf(Acl.class), ace, false);
  78     }
  79
  80     @Override
  81     protected void update(InstanceIdentifier<Ace> identifier, Ace origAce, Ace updatedAce) {
  82         AclKey aclKey = identifier.firstKeyOf(Acl.class);
  83         handlePolicyAceUpdate(aclKey, origAce, false);
  84         handlePolicyAceUpdate(aclKey, updatedAce, true);
  85     }
  86
  87     @Override
  88     protected void add(InstanceIdentifier<Ace> identifier, Ace ace) {
  89         handlePolicyAceUpdate(identifier.firstKeyOf(Acl.class), ace, true);
  90     }
  91
  92     private void handlePolicyAceUpdate(AclKey aclKey, Ace ace, boolean isAdded) {
  93         if (!PolicyServiceUtil.isPolicyAcl(aclKey.getAclType())) {
  94             return;
  95         }
  96
  97         LOG.trace("Policy ACE {} {}", ace, isAdded ? "updated" : "removed");
  98         String ruleName = ace.getRuleName();
  99         Optional<String> policyClassifierOpt = policyServiceUtil.getAcePolicyClassifier(ace);
 100         if (!policyClassifierOpt.isPresent()) {
 101             LOG.warn("No egress policy classifier found for ACE rule {}", ruleName);
 102             return;
 103         }
 104
 105
 106         String policyClassifier = policyClassifierOpt.get();
 107         List<String> underlayNetworks = policyServiceUtil.getUnderlayNetworksForClassifier(policyClassifier);
 108         if (underlayNetworks == null || underlayNetworks.isEmpty()) {
 109             LOG.debug("No underlay networks found for ACE rule {} classifier {}", ruleName, policyClassifier);
 110         }
 111
 112         policyServiceUtil.updateAclRuleForPolicyClassifier(policyClassifier, aclKey.getAclName(), ruleName, isAdded);
 113         List<BigInteger> dpIds = policyServiceUtil.getUnderlayNetworksDpns(underlayNetworks);
 114         if (dpIds == null || dpIds.isEmpty()) {
 115             LOG.debug("No DPNs found for installation of ACE rule {} networks {}", ace.getRuleName(), underlayNetworks);
 116             return;
 117         }
 118
 119         aceFlowProgrammer.programAceFlows(ace, policyClassifier, dpIds,
 120                 isAdded ? NwConstants.ADD_FLOW : NwConstants.DEL_FLOW);
 121     }
 122
 123 }