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