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