renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/EgressNatMapper.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.flow.FlowUtils.addNxRegMatch;
  12 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.applyActionIns;
  13 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.ethernetMatch;
  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.setIpv4SrcAction;
  17 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.setIpv6SrcAction;
  18
  19 import java.util.Collection;
  20
  21 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
  22 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfWriter;
  23 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.RegMatch;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.l3endpoint.rev151217.NatAddress;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg6;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * Manage the table that assigns source endpoint group, bridge domain, and
  46  * router domain to registers to be used by other tables.
  47  */
  48 public class EgressNatMapper extends FlowTable {
  49
  50     protected static final Logger LOG = LoggerFactory.getLogger(EgressNatMapper.class);
  51
  52     // TODO Li alagalah Improve UT coverage for this class.
  53     public static short TABLE_ID;
  54
  55     public EgressNatMapper(OfContext ctx, short tableId) {
  56         super(ctx);
  57         TABLE_ID=tableId;
  58     }
  59
  60     @Override
  61     public short getTableId() {
  62         return TABLE_ID;
  63     }
  64
  65     @Override
  66     public void sync(NodeId nodeId, OfWriter ofWriter) throws Exception {
  67         ofWriter.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(1), null, TABLE_ID));
  68
  69         Collection<EndpointL3> l3Endpoints = ctx.getEndpointManager().getL3EndpointsWithNat();
  70         for (EndpointL3 l3Ep : l3Endpoints) {
  71             Flow flow = addNatFlow(l3Ep);
  72             if (flow==null) {
  73                 continue;
  74             }
  75             ofWriter.writeFlow(nodeId, TABLE_ID, flow);
  76         }
  77     }
  78
  79     private Flow addNatFlow(EndpointL3 l3Ep) throws Exception {
  80         NatAddress natAugL3Endpoint = l3Ep.getAugmentation(NatAddress.class);
  81         // Match on L3 Nat Augmentation in Destination, set to IPAddress/Mac, send to SourceMapper
  82         if (natAugL3Endpoint != null) {
  83             return buildNatFlow(l3Ep.getIpAddress(), natAugL3Endpoint.getNatAddress(), l3Ep.getTenant(),
  84                     l3Ep.getL3Context());
  85         }
  86         return null;
  87     }
  88
  89     private Flow buildNatFlow(IpAddress insideAddress, IpAddress outsideAddress, TenantId tenantId, L3ContextId l3Ctx) throws Exception {
  90         MatchBuilder mb = new MatchBuilder();
  91         Action setSrcIp;
  92         String insideIpMatch;
  93         Layer3Match m;
  94
  95         FlowId flowid = new FlowId(new StringBuilder().append("EgressNat")
  96             .append("|")
  97             .append(insideAddress)
  98             .append("|")
  99             .append(outsideAddress)
 100             .toString());
 101         if (outsideAddress.getIpv4Address() != null) {
 102             setSrcIp = setIpv4SrcAction(outsideAddress.getIpv4Address());
 103
 104             insideIpMatch = insideAddress.getIpv4Address().getValue() + "/32";
 105             m = new Ipv4MatchBuilder().setIpv4Source(new Ipv4Prefix(insideIpMatch)).build();
 106             mb.setEthernetMatch(ethernetMatch(null, null, FlowUtils.IPv4)).setLayer3Match(m);
 107         } else if (outsideAddress.getIpv6Address() != null) {
 108             setSrcIp = setIpv6SrcAction(outsideAddress.getIpv6Address());
 109             insideIpMatch = insideAddress.getIpv6Address().getValue() + "/128";
 110             m = new Ipv6MatchBuilder().setIpv6Source(new Ipv6Prefix(insideIpMatch)).build();
 111             mb.setEthernetMatch(ethernetMatch(null, null, FlowUtils.IPv6)).setLayer3Match(m);
 112         } else {
 113             return null;
 114         }
 115
 116         addNxRegMatch(mb, RegMatch.of(NxmNxReg6.class, Long.valueOf(OrdinalFactory.getContextOrdinal(tenantId, l3Ctx))));
 117
 118         FlowBuilder flowb = base().setPriority(Integer.valueOf(100))
 119             .setId(flowid)
 120             .setMatch(mb.build())
 121             .setInstructions(
 122                     instructions(applyActionIns(setSrcIp), gotoTableIns(ctx.getPolicyManager().getTABLEID_EXTERNAL_MAPPER())));
 123         return flowb.build();
 124     }
 125 }