renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/PolicyEnforcer.java

   1 /*
   2  * Copyright (c) 2014 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
   9 package org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow;
  10
  11 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.EndpointManager.isExternal;
  12 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.addNxRegMatch;
  13 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.applyActionIns;
  14 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.gotoTableIns;
  15 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.instructions;
  16 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.nxOutputRegAction;
  17
  18 import java.util.ArrayList;
  19 import java.util.Collections;
  20 import java.util.Comparator;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Set;
  26
  27 import javax.annotation.concurrent.Immutable;
  28
  29 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
  30 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.PolicyManager.FlowMap;
  31 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.RegMatch;
  32 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.OrdinalFactory.EndpointFwdCtxOrdinals;
  33 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.Action;
  34 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.AllowAction;
  35 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.ClassificationResult;
  36 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.Classifier;
  37 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.ParamDerivator;
  38 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.SubjectFeatures;
  39 import org.opendaylight.groupbasedpolicy.resolver.EgKey;
  40 import org.opendaylight.groupbasedpolicy.resolver.EndpointConstraint;
  41 import org.opendaylight.groupbasedpolicy.resolver.IndexedTenant;
  42 import org.opendaylight.groupbasedpolicy.resolver.Policy;
  43 import org.opendaylight.groupbasedpolicy.resolver.PolicyInfo;
  44 import org.opendaylight.groupbasedpolicy.resolver.RuleGroup;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierDefinitionId;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ConditionName;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContext;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.HasDirection.Direction;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.action.refs.ActionRef;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRef;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroup;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroup.IntraGroupPolicy;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.subject.Rule;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ActionInstance;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ClassifierInstance;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg0;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg1;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg2;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg3;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg5;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg7;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeVxlan;
  78 import org.slf4j.Logger;
  79 import org.slf4j.LoggerFactory;
  80
  81 import com.google.common.base.Preconditions;
  82 import com.google.common.collect.ComparisonChain;
  83 import com.google.common.collect.Ordering;
  84 import com.google.common.collect.Table.Cell;
  85
  86 /**
  87  * Manage the table that enforces policy on the traffic. Traffic is denied
  88  * unless specifically allowed by policy
  89  */
  90 public class PolicyEnforcer extends FlowTable {
  91
  92     protected static final Logger LOG = LoggerFactory.getLogger(PolicyEnforcer.class);
  93
  94     private static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction gotoEgressNatInstruction;
  95     private static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction gotoExternalInstruction;
  96
  97     public static short TABLE_ID;
  98
  99     public PolicyEnforcer(OfContext ctx, short tableId) {
 100         super(ctx);
 101         this.TABLE_ID = tableId;
 102         this.gotoEgressNatInstruction = gotoTableIns(ctx.getPolicyManager().getTABLEID_EGRESS_NAT());
 103         this.gotoExternalInstruction = gotoTableIns(ctx.getPolicyManager().getTABLEID_EXTERNAL_MAPPER());
 104     }
 105
 106     @Override
 107     public short getTableId() {
 108         return TABLE_ID;
 109     }
 110
 111     @Override
 112     public void sync(NodeId nodeId, PolicyInfo policyInfo, FlowMap flowMap) throws Exception {
 113
 114         flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(1), null, TABLE_ID));
 115
 116         NodeConnectorId tunPort = ctx.getSwitchManager().getTunnelPort(nodeId, TunnelTypeVxlan.class);
 117         if (tunPort != null) {
 118             flowMap.writeFlow(nodeId, TABLE_ID, allowFromTunnel(tunPort));
 119         }
 120
 121         HashSet<PolicyPair> visitedPairs = new HashSet<>();
 122         HashSet<PolicyPair> visitedReversePairs = new HashSet<>();
 123
 124         // Used for ARP flows
 125         Set<Integer> fdIds = new HashSet<>();
 126
 127         for (Endpoint srcEp : ctx.getEndpointManager().getEndpointsForNode(nodeId)) {
 128             for (EgKey srcEpgKey : ctx.getEndpointManager().getEgKeysForEndpoint(srcEp)) {
 129                 Set<EgKey> peers = policyInfo.getPeers(srcEpgKey);
 130                 for (EgKey dstEpgKey : peers) {
 131                     Set<Endpoint> dstEndpoints = new HashSet<>();
 132                     dstEndpoints.addAll(ctx.getEndpointManager().getEndpointsForGroup(dstEpgKey));
 133                     dstEndpoints.addAll(ctx.getEndpointManager().getExtEpsNoLocForGroup(dstEpgKey));
 134                     for (Endpoint dstEp : dstEndpoints) {
 135
 136                         EndpointFwdCtxOrdinals srcEpFwdCxtOrds = OrdinalFactory.getEndpointFwdCtxOrdinals(ctx,
 137                                 policyInfo, srcEp);
 138                         EndpointFwdCtxOrdinals dstEpFwdCxtOrds = OrdinalFactory.getEndpointFwdCtxOrdinals(ctx,
 139                                 policyInfo, dstEp);
 140                         int dcgId = dstEpFwdCxtOrds.getCgId();
 141                         int depgId = dstEpFwdCxtOrds.getEpgId();
 142                         int scgId = srcEpFwdCxtOrds.getCgId();
 143                         int sepgId = srcEpFwdCxtOrds.getEpgId();
 144
 145                         fdIds.add(srcEpFwdCxtOrds.getFdId());
 146                         NetworkElements netElements = new NetworkElements(srcEp, dstEp, nodeId, ctx, policyInfo);
 147
 148                         Policy policy = policyInfo.getPolicy(dstEpgKey, srcEpgKey);
 149                         for (Cell<EndpointConstraint, EndpointConstraint, List<RuleGroup>> activeRulesByConstraints : getActiveRulesBetweenEps(
 150                                 policy, dstEp, srcEp)) {
 151                             Set<IpPrefix> sIpPrefixes = Policy.getIpPrefixesFrom(activeRulesByConstraints.getRowKey()
 152                                 .getL3EpPrefixes());
 153                             Set<IpPrefix> dIpPrefixes = Policy.getIpPrefixesFrom(activeRulesByConstraints.getColumnKey()
 154                                 .getL3EpPrefixes());
 155                             PolicyPair policyPair = new PolicyPair(depgId, sepgId, dcgId, scgId, dIpPrefixes,
 156                                     sIpPrefixes, netElements.getDstNodeId(), netElements.getSrcNodeId());
 157                             if (visitedPairs.contains(policyPair)) {
 158                                 LOG.trace("PolicyEnforcer: Already visited PolicyPair {}, endpoints {} {} skipped",
 159                                         policyPair, srcEp.getKey(), dstEp.getKey());
 160                                 continue;
 161                             } else {
 162                                 LOG.trace("PolicyEnforcer: Visiting PolicyPair {} endpoints {} {}", policyPair,
 163                                         srcEp.getKey(), dstEp.getKey());
 164                                 visitedPairs.add(policyPair);
 165                             }
 166                             syncPolicy(flowMap, netElements, activeRulesByConstraints.getValue(), policyPair);
 167                         }
 168
 169                         // Reverse
 170                         policy = policyInfo.getPolicy(srcEpgKey, dstEpgKey);
 171                         for (Cell<EndpointConstraint, EndpointConstraint, List<RuleGroup>> activeRulesByConstraints : getActiveRulesBetweenEps(
 172                                 policy, srcEp, dstEp)) {
 173                             Set<IpPrefix> sIpPrefixes = Policy.getIpPrefixesFrom(activeRulesByConstraints.getRowKey()
 174                                 .getL3EpPrefixes());
 175                             Set<IpPrefix> dIpPrefixes = Policy.getIpPrefixesFrom(activeRulesByConstraints.getColumnKey()
 176                                 .getL3EpPrefixes());
 177                             PolicyPair policyPair = new PolicyPair(sepgId, depgId, scgId, dcgId, sIpPrefixes,
 178                                     dIpPrefixes, netElements.getSrcNodeId(), netElements.getDstNodeId());
 179                             if (visitedReversePairs.contains(policyPair)) {
 180                                 LOG.trace(
 181                                         "PolicyEnforcer: Reverse: Already visited PolicyPair {}, endpoints {} {} skipped",
 182                                         policyPair, srcEp.getKey(), dstEp.getKey());
 183                                 continue;
 184                             } else {
 185                                 LOG.trace("PolicyEnforcer: Reverse: Visiting: PolicyPair {} via endpoints {} {}",
 186                                         policyPair, srcEp.getKey(), dstEp.getKey());
 187                                 visitedReversePairs.add(policyPair);
 188
 189                             }
 190                             syncPolicy(flowMap, netElements, activeRulesByConstraints.getValue(), policyPair);
 191                         }
 192                     }
 193                 }
 194             }
 195         }
 196
 197         // Allow same EPG
 198         for (Endpoint srcEp : ctx.getEndpointManager().getEndpointsForNode(nodeId)) {
 199             for (EgKey srcEpgKey : ctx.getEndpointManager().getEgKeysForEndpoint(srcEp)) {
 200
 201                 IndexedTenant tenant = ctx.getPolicyResolver().getTenant(srcEpgKey.getTenantId());
 202                 EndpointGroup group = tenant.getEndpointGroup(srcEpgKey.getEgId());
 203                 IntraGroupPolicy igp = group.getIntraGroupPolicy();
 204
 205                 if (igp == null || igp.equals(IntraGroupPolicy.Allow)) {
 206                     for (Endpoint dstEp : ctx.getEndpointManager().getEndpointsForGroup(srcEpgKey)) {
 207                         EndpointFwdCtxOrdinals srcEpFwdCxtOrds = OrdinalFactory.getEndpointFwdCtxOrdinals(ctx,
 208                                 policyInfo, srcEp);
 209                         EndpointFwdCtxOrdinals dstEpFwdCxtOrds = OrdinalFactory.getEndpointFwdCtxOrdinals(ctx,
 210                                 policyInfo, dstEp);
 211                         int depgId = dstEpFwdCxtOrds.getEpgId();
 212                         int sepgId = srcEpFwdCxtOrds.getEpgId();
 213                         flowMap.writeFlow(nodeId, TABLE_ID, allowSameEpg(sepgId, depgId));
 214                         flowMap.writeFlow(nodeId, TABLE_ID, allowSameEpg(depgId, sepgId));
 215                     }
 216                 }
 217             }
 218         }
 219
 220         // Write ARP flows per flood domain.
 221         for (Integer fdId : fdIds) {
 222             flowMap.writeFlow(nodeId, TABLE_ID, createArpFlow(fdId));
 223         }
 224     }
 225
 226     private Flow createArpFlow(Integer fdId) {
 227
 228         Long etherType = FlowUtils.ARP;
 229         // L2 Classifier so 20,000 for now
 230         Integer priority = 20000;
 231
 232         MatchBuilder mb = new MatchBuilder().setEthernetMatch(FlowUtils.ethernetMatch(null, null, etherType));
 233
 234         addNxRegMatch(mb, RegMatch.of(NxmNxReg5.class, Long.valueOf(fdId)));
 235
 236         Match match = mb.build();
 237         FlowId flowid = FlowIdUtils.newFlowId(TABLE_ID, "arp", match);
 238         Flow flow = base().setPriority(priority)
 239             .setId(flowid)
 240             .setMatch(match)
 241             .setInstructions(instructions(applyActionIns(nxOutputRegAction(NxmNxReg7.class))))
 242             .build();
 243         return flow;
 244     }
 245
 246     private Flow allowSameEpg(int sepgId, int depgId) {
 247
 248         MatchBuilder mb = new MatchBuilder();
 249         addNxRegMatch(mb, RegMatch.of(NxmNxReg0.class, Long.valueOf(sepgId)),
 250                 RegMatch.of(NxmNxReg2.class, Long.valueOf(depgId)));
 251         Match match = mb.build();
 252         FlowId flowId = FlowIdUtils.newFlowId(TABLE_ID, "intraallow", match);
 253         FlowBuilder flow = base().setId(flowId)
 254             .setMatch(match)
 255             .setPriority(65000)
 256             .setInstructions(instructions(applyActionIns(nxOutputRegAction(NxmNxReg7.class))));
 257         return flow.build();
 258     }
 259
 260     private Flow allowFromTunnel(NodeConnectorId tunPort) {
 261
 262         MatchBuilder mb = new MatchBuilder().setInPort(tunPort);
 263         addNxRegMatch(mb, RegMatch.of(NxmNxReg1.class, Long.valueOf(0xffffff)));
 264         Match match = mb.build();
 265         FlowId flowId = FlowIdUtils.newFlowId(TABLE_ID, "tunnelallow", match);
 266         FlowBuilder flow = base().setId(flowId)
 267             .setMatch(match)
 268             .setPriority(65000)
 269             .setInstructions(instructions(applyActionIns(nxOutputRegAction(NxmNxReg7.class))));
 270         return flow.build();
 271
 272     }
 273
 274     private void syncPolicy(FlowMap flowMap, NetworkElements netElements, List<RuleGroup> rgs, PolicyPair policyPair) {
 275         int priority = 65000;
 276         for (RuleGroup rg : rgs) {
 277             TenantId tenantId = rg.getContractTenant().getId();
 278             IndexedTenant tenant = ctx.getPolicyResolver().getTenant(tenantId);
 279             for (Rule r : rg.getRules()) {
 280                 syncDirection(flowMap, netElements, tenant, policyPair, r, Direction.In, priority);
 281                 syncDirection(flowMap, netElements, tenant, policyPair, r, Direction.Out, priority);
 282
 283                 priority -= 1;
 284             }
 285         }
 286     }
 287
 288     /**
 289      * Private internal class for ordering Actions in Rules. The order is
 290      * determined first by the value of the order parameter, with the lower
 291      * order actions being applied first; for Actions with either the same order
 292      * or no order, ordering is lexicographical by name.
 293      */
 294     private static class ActionRefComparator implements Comparator<ActionRef> {
 295
 296         public static final ActionRefComparator INSTANCE = new ActionRefComparator();
 297
 298         @Override
 299         public int compare(ActionRef arg0, ActionRef arg1) {
 300             return ComparisonChain.start()
 301                 .compare(arg0.getOrder(), arg1.getOrder(), Ordering.natural().nullsLast())
 302                 .compare(arg0.getName().getValue(), arg1.getName().getValue(), Ordering.natural().nullsLast())
 303                 .result();
 304         }
 305
 306     }
 307
 308     private void syncDirection(FlowMap flowMap, NetworkElements netElements, IndexedTenant contractTenant,
 309             PolicyPair policyPair, Rule rule, Direction direction, int priority) {
 310         /*
 311          * Create the ordered action list. The implicit action is "allow", and
 312          * is therefore always in the list
 313          */
 314
 315         List<ActionBuilder> actionBuilderList = new ArrayList<ActionBuilder>();
 316         if (rule.getActionRef() != null) {
 317             /*
 318              * Pre-sort by references using order, then name
 319              */
 320             List<ActionRef> actionRefList = new ArrayList<ActionRef>(rule.getActionRef());
 321             Collections.sort(actionRefList, ActionRefComparator.INSTANCE);
 322
 323             for (ActionRef actionRule : actionRefList) {
 324                 ActionInstance actionInstance = contractTenant.getAction(actionRule.getName());
 325                 if (actionInstance == null) {
 326                     // XXX TODO fail the match and raise an exception
 327                     LOG.warn("Action instance {} not found", actionRule.getName().getValue());
 328                     return;
 329                 }
 330                 Action action = SubjectFeatures.getAction(actionInstance.getActionDefinitionId());
 331                 if (action == null) {
 332                     // XXX TODO fail the match and raise an exception
 333                     LOG.warn("Action definition {} not found", actionInstance.getActionDefinitionId().getValue());
 334                     return;
 335                 }
 336
 337                 Map<String, Object> params = new HashMap<>();
 338                 if (actionInstance.getParameterValue() != null) {
 339                     for (ParameterValue v : actionInstance.getParameterValue()) {
 340                         if (v.getName() == null)
 341                             continue;
 342                         if (v.getIntValue() != null) {
 343                             params.put(v.getName().getValue(), v.getIntValue());
 344                         } else if (v.getStringValue() != null) {
 345                             params.put(v.getName().getValue(), v.getStringValue());
 346                         }
 347                     }
 348                 }
 349                 /*
 350                  * Convert the GBP Action to one or more OpenFlow Actions
 351                  */
 352                 if (!(actionRefList.indexOf(actionRule) == (actionRefList.size() - 1) && action.equals(SubjectFeatures.getAction(AllowAction.DEFINITION.getId())))) {
 353                     actionBuilderList = action.updateAction(actionBuilderList, params, actionRule.getOrder(), netElements, policyPair, flowMap, ctx);
 354                 }
 355
 356             }
 357         }
 358
 359         Map<String, ParameterValue> paramsFromClassifier = new HashMap<>();
 360         Set<ClassifierDefinitionId> classifiers = new HashSet<>();
 361         for (ClassifierRef cr : rule.getClassifierRef()) {
 362             if (cr.getDirection() != null && !cr.getDirection().equals(Direction.Bidirectional)
 363                     && !cr.getDirection().equals(direction)) {
 364                 continue;
 365             }
 366
 367             // XXX - TODO - implement connection tracking (requires openflow
 368             // extension and data plane support - in 2.4. Will need to handle
 369             // case where we are working with mix of nodes.
 370
 371             ClassifierInstance ci = contractTenant.getClassifier(cr.getName());
 372             if (ci == null) {
 373                 // XXX TODO fail the match and raise an exception
 374                 LOG.warn("Classifier instance {} not found", cr.getName().getValue());
 375                 return;
 376             }
 377             Classifier cfier = SubjectFeatures.getClassifier(ci.getClassifierDefinitionId());
 378             if (cfier == null) {
 379                 // XXX TODO fail the match and raise an exception
 380                 LOG.warn("Classifier definition {} not found", ci.getClassifierDefinitionId().getValue());
 381                 return;
 382             }
 383             classifiers.add(new ClassifierDefinitionId(ci.getClassifierDefinitionId()));
 384             for (ParameterValue v : ci.getParameterValue()) {
 385                 if (paramsFromClassifier.get(v.getName().getValue()) == null) {
 386                     if (v.getIntValue() != null || v.getStringValue() != null || v.getRangeValue() != null) {
 387                         paramsFromClassifier.put(v.getName().getValue(), v);
 388                     }
 389                 } else {
 390                     if (!paramsFromClassifier.get(v.getName().getValue()).equals(v)) {
 391                         throw new IllegalArgumentException("Classification error in rule: " + rule.getName()
 392                                 + ".\nCause: " + "Classification conflict detected at parameter " + v.getName());
 393                     }
 394                 }
 395             }
 396         }
 397         if (classifiers.isEmpty()) {
 398             return;
 399         }
 400         List<Map<String, ParameterValue>> derivedParamsByName = ParamDerivator.ETHER_TYPE_DERIVATOR.deriveParameter(paramsFromClassifier);
 401         List<MatchBuilder> flowMatchBuilders = new ArrayList<>();
 402         for (Map<String, ParameterValue> params : derivedParamsByName) {
 403             List<MatchBuilder> matchBuildersToResolve = new ArrayList<>();
 404             if (policyPair.consumerEicIpPrefixes.isEmpty() && policyPair.providerEicIpPrefixes.isEmpty()) {
 405                 matchBuildersToResolve.add(createBaseMatch(direction, policyPair, null, null));
 406             } else if (!policyPair.consumerEicIpPrefixes.isEmpty() && policyPair.providerEicIpPrefixes.isEmpty()) {
 407                 for (IpPrefix sIpPrefix : policyPair.consumerEicIpPrefixes) {
 408                     matchBuildersToResolve.add(createBaseMatch(direction, policyPair, sIpPrefix, null));
 409                 }
 410             } else if (policyPair.consumerEicIpPrefixes.isEmpty() && !policyPair.providerEicIpPrefixes.isEmpty()) {
 411                 for (IpPrefix dIpPrefix : policyPair.consumerEicIpPrefixes) {
 412                     matchBuildersToResolve.add(createBaseMatch(direction, policyPair, null, dIpPrefix));
 413                 }
 414             } else {
 415                 for (IpPrefix sIpPrefix : policyPair.consumerEicIpPrefixes) {
 416                     for (IpPrefix dIpPrefix : policyPair.consumerEicIpPrefixes) {
 417                         matchBuildersToResolve.add(createBaseMatch(direction, policyPair, sIpPrefix, dIpPrefix));
 418                     }
 419                 }
 420             }
 421             for (ClassifierDefinitionId clDefId : classifiers) {
 422                 Classifier classifier = SubjectFeatures.getClassifier(clDefId);
 423                 ClassificationResult result = classifier.updateMatch(matchBuildersToResolve, params);
 424                 if (!result.isSuccessfull()) {
 425                     // TODO consider different handling.
 426                     throw new IllegalArgumentException("Classification conflict detected in rule: " + rule.getName()
 427                             + ".\nCause: " + result.getErrorMessage());
 428                 }
 429                 matchBuildersToResolve = new ArrayList<>(result.getMatchBuilders());
 430             }
 431             flowMatchBuilders.addAll(matchBuildersToResolve);
 432         }
 433
 434         FlowBuilder flow = base().setPriority(Integer.valueOf(priority));
 435         for (MatchBuilder mb : flowMatchBuilders) {
 436             Match match = mb.build();
 437             FlowId flowId = FlowIdUtils.newFlowId(TABLE_ID, "cg", match);
 438             flow.setMatch(match).setId(flowId).setPriority(Integer.valueOf(priority));
 439
 440             /*
 441              * If destination is External, the last Action ALLOW must be changed to goto
 442              * NAT/External table.
 443              * If actionBuilderList is empty (we removed the last Allow) then go straight to
 444              * ExternalMapper table.
 445              */
 446
 447             if (isExternal(netElements.getDstEp())) {
 448                 flow.setInstructions(instructions(getGotoEgressNatInstruction()));
 449             } else if (actionBuilderList.isEmpty()) {
 450                 flow.setInstructions(instructions(getGotoExternalInstruction()));
 451             } else {
 452                 flow.setInstructions(instructions(applyActionIns(actionBuilderList), getGotoExternalInstruction()));
 453             }
 454             flowMap.writeFlow(netElements.getLocalNodeId(), TABLE_ID, flow.build());
 455         }
 456     }
 457
 458     private MatchBuilder createBaseMatch(Direction direction, PolicyPair policyPair, IpPrefix sIpPrefix,
 459             IpPrefix dIpPrefix) {
 460         MatchBuilder baseMatch = new MatchBuilder();
 461         if (direction.equals(Direction.In)) {
 462             addNxRegMatch(baseMatch, RegMatch.of(NxmNxReg0.class, Long.valueOf(policyPair.consumerEpgId)),
 463                     RegMatch.of(NxmNxReg1.class, Long.valueOf(policyPair.consumerCondGrpId)),
 464                     RegMatch.of(NxmNxReg2.class, Long.valueOf(policyPair.providerEpgId)),
 465                     RegMatch.of(NxmNxReg3.class, Long.valueOf(policyPair.providerCondGrpId)));
 466             if (sIpPrefix != null) {
 467                 baseMatch.setLayer3Match(createLayer3Match(sIpPrefix, true));
 468             }
 469             if (dIpPrefix != null) {
 470                 baseMatch.setLayer3Match(createLayer3Match(dIpPrefix, true));
 471             }
 472         } else {
 473             addNxRegMatch(baseMatch, RegMatch.of(NxmNxReg0.class, Long.valueOf(policyPair.providerEpgId)),
 474                     RegMatch.of(NxmNxReg1.class, Long.valueOf(policyPair.providerCondGrpId)),
 475                     RegMatch.of(NxmNxReg2.class, Long.valueOf(policyPair.consumerEpgId)),
 476                     RegMatch.of(NxmNxReg3.class, Long.valueOf(policyPair.consumerCondGrpId)));
 477             if (sIpPrefix != null) {
 478                 baseMatch.setLayer3Match(createLayer3Match(sIpPrefix, false));
 479             }
 480             if (dIpPrefix != null) {
 481                 baseMatch.setLayer3Match(createLayer3Match(dIpPrefix, false));
 482             }
 483         }
 484         return baseMatch;
 485     }
 486
 487     private Layer3Match createLayer3Match(IpPrefix ipPrefix, boolean isSrc) {
 488         if (ipPrefix.getIpv4Prefix() != null) {
 489             if (isSrc) {
 490                 return new Ipv4MatchBuilder().setIpv4Source(ipPrefix.getIpv4Prefix()).build();
 491             } else {
 492                 return new Ipv4MatchBuilder().setIpv4Destination(ipPrefix.getIpv4Prefix()).build();
 493             }
 494         } else {
 495             if (isSrc) {
 496                 return new Ipv6MatchBuilder().setIpv6Source(ipPrefix.getIpv6Prefix()).build();
 497             } else {
 498                 return new Ipv6MatchBuilder().setIpv6Destination(ipPrefix.getIpv6Prefix()).build();
 499             }
 500         }
 501     }
 502
 503     // TODO: move to a common utils for all renderers
 504     public List<Cell<EndpointConstraint, EndpointConstraint, List<RuleGroup>>> getActiveRulesBetweenEps(Policy policy,
 505             Endpoint consEp, Endpoint provEp) {
 506         List<Cell<EndpointConstraint, EndpointConstraint, List<RuleGroup>>> rulesWithEpConstraints = new ArrayList<>();
 507         if (policy.getRuleMap() != null) {
 508             for (Cell<EndpointConstraint, EndpointConstraint, List<RuleGroup>> cell : policy.getRuleMap().cellSet()) {
 509                 EndpointConstraint consEpConstraint = cell.getRowKey();
 510                 EndpointConstraint provEpConstraint = cell.getColumnKey();
 511                 if (epMatchesConstraint(consEp, consEpConstraint) && epMatchesConstraint(provEp, provEpConstraint)) {
 512                     rulesWithEpConstraints.add(cell);
 513                 }
 514             }
 515         }
 516         return rulesWithEpConstraints;
 517     }
 518
 519     private boolean epMatchesConstraint(Endpoint ep, EndpointConstraint constraint) {
 520         List<ConditionName> epConditions = Collections.emptyList();
 521         if (ep.getCondition() != null) {
 522             epConditions = ep.getCondition();
 523         }
 524         return constraint.getConditionSet().matches(epConditions);
 525     }
 526
 527     private static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction getGotoEgressNatInstruction() {
 528         return gotoEgressNatInstruction;
 529     }
 530
 531     private static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction getGotoExternalInstruction() {
 532         return gotoExternalInstruction;
 533     }
 534
 535     @Immutable
 536     public static class PolicyPair {
 537
 538         private final int consumerEpgId;
 539         private final int providerEpgId;
 540         private final int consumerCondGrpId;
 541         private final int providerCondGrpId;
 542         private final Set<IpPrefix> consumerEicIpPrefixes;
 543         private final Set<IpPrefix> providerEicIpPrefixes;
 544         private NodeId consumerEpNodeId;
 545         private NodeId providerEpNodeId;
 546
 547         public int getConsumerEpgId() {
 548             return consumerEpgId;
 549         }
 550
 551         public int getProviderEpgId() {
 552             return providerEpgId;
 553         }
 554
 555         public NodeId getConsumerEpNodeId() {
 556             return consumerEpNodeId;
 557         }
 558
 559         public NodeId getProviderEpNodeId() {
 560             return providerEpNodeId;
 561         }
 562
 563         public PolicyPair(int consumerEpgId, int providerEpgId, int consumerCondGrpId, int providerCondGrpId,
 564                 Set<IpPrefix> consumerEicIpPrefixes, Set<IpPrefix> providerEicIpPrefixes, NodeId consumerEpNodeId, NodeId providerEpNodeId) {
 565             super();
 566             this.consumerEpgId = consumerEpgId;
 567             this.providerEpgId = providerEpgId;
 568             this.consumerCondGrpId = consumerCondGrpId;
 569             this.providerCondGrpId = providerCondGrpId;
 570             this.consumerEicIpPrefixes = consumerEicIpPrefixes;
 571             this.providerEicIpPrefixes = providerEicIpPrefixes;
 572             this.consumerEpNodeId = consumerEpNodeId;
 573             this.providerEpNodeId = providerEpNodeId;
 574         }
 575
 576         @Override
 577         public int hashCode() {
 578             final int prime = 31;
 579             int result = 1;
 580             result = prime * result + ((providerEicIpPrefixes == null) ? 0 : providerEicIpPrefixes.hashCode());
 581             result = prime * result + providerCondGrpId;
 582             result = prime * result + providerEpgId;
 583             result = prime * result + ((consumerEicIpPrefixes == null) ? 0 : consumerEicIpPrefixes.hashCode());
 584             result = prime * result + consumerCondGrpId;
 585             result = prime * result + consumerEpgId;
 586             result = prime * result + ((consumerEpNodeId == null) ? 0 : consumerEpNodeId.hashCode());
 587             result = prime * result + ((providerEpNodeId == null) ? 0 : providerEpNodeId.hashCode());
 588
 589             return result;
 590         }
 591
 592         @Override
 593         public boolean equals(Object obj) {
 594             if (this == obj)
 595                 return true;
 596             if (obj == null)
 597                 return false;
 598             if (getClass() != obj.getClass())
 599                 return false;
 600             PolicyPair other = (PolicyPair) obj;
 601             if (providerEicIpPrefixes == null) {
 602                 if (other.providerEicIpPrefixes != null) {
 603                     return false;
 604                 }
 605             } else if (!providerEicIpPrefixes.equals(other.providerEicIpPrefixes)) {
 606                 return false;
 607             }
 608             if (consumerEicIpPrefixes == null) {
 609                 if (other.consumerEicIpPrefixes != null) {
 610                     return false;
 611                 }
 612             } else if (!consumerEicIpPrefixes.equals(other.consumerEicIpPrefixes)) {
 613                 return false;
 614             }
 615             if (consumerEpNodeId == null) {
 616                 if (other.consumerEpNodeId != null) {
 617                     return false;
 618                 }
 619             } else if (!consumerEpNodeId.getValue().equals(other.consumerEpNodeId.getValue())) {
 620                 return false;
 621             }
 622             if (providerEpNodeId == null) {
 623                 if (other.providerEpNodeId != null) {
 624                     return false;
 625                 }
 626             } else if (!providerEpNodeId.getValue().equals(other.providerEpNodeId.getValue())) {
 627                 return false;
 628             }
 629             if (providerCondGrpId != other.providerCondGrpId)
 630                 return false;
 631             if (providerEpgId != other.providerEpgId)
 632                 return false;
 633             if (consumerCondGrpId != other.consumerCondGrpId)
 634                 return false;
 635             if (consumerEpgId != other.consumerEpgId)
 636                 return false;
 637
 638             return true;
 639         }
 640
 641         @Override
 642         public String toString() {
 643             return new StringBuilder().append("consumerEPG: ")
 644                 .append(consumerEpgId)
 645                 .append("consumerCG: ")
 646                 .append(consumerCondGrpId)
 647                 .append("providerEPG: ")
 648                 .append(providerEpgId)
 649                 .append("providerCG: ")
 650                 .append(providerCondGrpId)
 651                 .append("consumerEpNodeId: ")
 652                 .append(consumerEpNodeId)
 653                 .append("providerEpNodeId: ")
 654                 .append(providerEpNodeId)
 655                 .append("consumerEicIpPrefixes: ")
 656                 .append(consumerEicIpPrefixes)
 657                 .append("providerEicIpPrefixes: ")
 658                 .append(providerEicIpPrefixes)
 659                 .toString();
 660         }
 661     }
 662
 663     public class NetworkElements {
 664
 665         private Endpoint srcEp;
 666         private Endpoint dstEp;
 667         private NodeId srcNodeId;
 668         private NodeId dstNodeId;
 669         private NodeId localNodeId;
 670         private EndpointFwdCtxOrdinals srcEpOrds;
 671         private EndpointFwdCtxOrdinals dstEpOrds;
 672
 673         public NetworkElements(Endpoint srcEp, Endpoint dstEp, NodeId nodeId, OfContext ctx, PolicyInfo policyInfo)
 674                 throws Exception {
 675             Preconditions.checkArgument(srcEp.getAugmentation(OfOverlayContext.class) != null);
 676             Preconditions.checkArgument(dstEp.getAugmentation(OfOverlayContext.class) != null);
 677
 678             this.srcEp = srcEp;
 679             this.dstEp = dstEp;
 680             this.localNodeId = nodeId;
 681             this.srcEpOrds = OrdinalFactory.getEndpointFwdCtxOrdinals(ctx, policyInfo, srcEp);
 682             this.dstEpOrds = OrdinalFactory.getEndpointFwdCtxOrdinals(ctx, policyInfo, dstEp);
 683             this.dstNodeId = dstEp.getAugmentation(OfOverlayContext.class).getNodeId();
 684             this.srcNodeId = srcEp.getAugmentation(OfOverlayContext.class).getNodeId();
 685         }
 686
 687
 688         Endpoint getSrcEp() {
 689             return srcEp;
 690         }
 691
 692
 693         Endpoint getDstEp() {
 694             return dstEp;
 695         }
 696
 697
 698         NodeId getSrcNodeId() {
 699             return srcNodeId;
 700         }
 701
 702
 703         public NodeId getDstNodeId() {
 704             return dstNodeId;
 705         }
 706
 707
 708         public NodeId getLocalNodeId() {
 709             return localNodeId;
 710         }
 711
 712
 713         public EndpointFwdCtxOrdinals getSrcEpOrds() {
 714             return srcEpOrds;
 715         }
 716
 717
 718         EndpointFwdCtxOrdinals getDstEpOrds() {
 719             return dstEpOrds;
 720         }
 721
 722
 723
 724     }
 725 }