openstack/net-virt-providers/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/services/ArpResponderService.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.
   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  * Authors : Madhu Venugopal, Dave Tucker
   9  */
  10 package org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13.services;
  11
  12 import java.math.BigInteger;
  13 import java.net.InetAddress;
  14 import java.util.List;
  15
  16 import org.opendaylight.controller.sal.core.Node;
  17 import org.opendaylight.controller.sal.utils.Status;
  18 import org.opendaylight.controller.sal.utils.StatusCode;
  19 import org.opendaylight.ovsdb.openstack.netvirt.api.Action;
  20 import org.opendaylight.ovsdb.openstack.netvirt.api.ArpProvider;
  21 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
  22 import org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13.AbstractServiceInstance;
  23 import org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13.OF13Provider;
  24 import org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13.Service;
  25 import org.opendaylight.ovsdb.utils.mdsal.openflow.ActionUtils;
  26 import org.opendaylight.ovsdb.utils.mdsal.openflow.InstructionUtils;
  27 import org.opendaylight.ovsdb.utils.mdsal.openflow.MatchUtils;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  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.inventory.rev130819.tables.table.FlowKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
  40
  41 import com.google.common.collect.Lists;
  42
  43 public class ArpResponderService extends AbstractServiceInstance implements ArpProvider {
  44     public ArpResponderService() {
  45         super(Service.ARP_RESPONDER);
  46     }
  47
  48     public ArpResponderService(Service service) {
  49         super(service);
  50     }
  51
  52     @Override
  53     public boolean isBridgeInPipeline (String nodeId) {
  54         return true;
  55     }
  56
  57     @Override
  58     public Status programStaticArpEntry(Node node, Long dpid, String segmentationId, String macAddressStr,
  59                                         InetAddress ipAddress, Action action) {
  60
  61         String nodeName = Constants.OPENFLOW_NODE_PREFIX + dpid;
  62         MacAddress macAddress = new MacAddress(macAddressStr);
  63
  64         MatchBuilder matchBuilder = new MatchBuilder();
  65         NodeBuilder nodeBuilder = OF13Provider.createNodeBuilder(nodeName);
  66
  67         // Instructions List Stores Individual Instructions
  68         InstructionsBuilder isb = new InstructionsBuilder();
  69         List<Instruction> instructions = Lists.newArrayList();
  70         InstructionBuilder ib = new InstructionBuilder();
  71
  72         MatchUtils.createTunnelIDMatch(matchBuilder, new BigInteger(segmentationId));
  73         MatchUtils.createEtherTypeMatch(matchBuilder, new EtherType(Constants.ARP_ETHERTYPE));
  74
  75         // Move Eth Src to Eth Dst
  76         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.nxMoveEthSrcToEthDstAction()));
  77         ib.setOrder(0);
  78         ib.setKey(new InstructionKey(0));
  79         instructions.add(ib.build());
  80
  81         // Set Eth Src
  82         InstructionUtils.createDlSrcInstructions(ib, macAddress);
  83         ib.setOrder(1);
  84         ib.setKey(new InstructionKey(1));
  85         instructions.add(ib.build());
  86
  87         // Set ARP OP
  88         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.nxLoadArpOpAction(BigInteger.valueOf(0x02L))));
  89         ib.setOrder(2);
  90         ib.setKey(new InstructionKey(2));
  91         instructions.add(ib.build());
  92
  93         // Move ARP SHA to ARP THA
  94         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.nxMoveArpShaToArpThaAction()));
  95         ib.setOrder(3);
  96         ib.setKey(new InstructionKey(3));
  97         instructions.add(ib.build());
  98
  99         // Move ARP SPA to ARP TPA
 100         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.nxMoveArpSpaToArpTpaAction()));
 101         ib.setOrder(4);
 102         ib.setKey(new InstructionKey(4));
 103         instructions.add(ib.build());
 104
 105         // Load Mac to ARP SHA
 106         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.nxLoadArpShaAction(macAddress)));
 107         ib.setOrder(5);
 108         ib.setKey(new InstructionKey(5));
 109         instructions.add(ib.build());
 110
 111         // Load IP to ARP SPA
 112         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.nxLoadArpSpaAction(ipAddress.getHostAddress())));
 113         ib.setOrder(6);
 114         ib.setKey(new InstructionKey(6));
 115         instructions.add(ib.build());
 116
 117         // Output of InPort
 118         ib.setInstruction(InstructionUtils.applyActionIns(ActionUtils.outputAction(new NodeConnectorId(nodeName + ":INPORT"))));
 119         ib.setOrder(7);
 120         ib.setKey(new InstructionKey(7));
 121         instructions.add(ib.build());
 122
 123         FlowBuilder flowBuilder = new FlowBuilder();
 124         flowBuilder.setMatch(matchBuilder.build());
 125         flowBuilder.setInstructions(isb.setInstruction(instructions).build());
 126
 127         String flowId = "ArpResponder_" + ipAddress.getHostAddress();
 128         flowBuilder.setId(new FlowId(flowId));
 129         FlowKey key = new FlowKey(new FlowId(flowId));
 130         flowBuilder.setBarrier(true);
 131         flowBuilder.setTableId(this.getTable());
 132         flowBuilder.setKey(key);
 133         flowBuilder.setPriority(1024);
 134         flowBuilder.setFlowName(flowId);
 135         flowBuilder.setHardTimeout(0);
 136         flowBuilder.setIdleTimeout(0);
 137         writeFlow(flowBuilder, nodeBuilder);
 138
 139         if (action.equals(Action.ADD)) {
 140             writeFlow(flowBuilder, nodeBuilder);
 141         } else {
 142             removeFlow(flowBuilder, nodeBuilder);
 143         }
 144
 145         // ToDo: WriteFlow/RemoveFlow should return something we can use to check success
 146         return new Status(StatusCode.SUCCESS);
 147     }
 148 }