| /* |
| * Copyright 2016-present Open Networking Laboratory |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.onosproject.driver.extensions; |
| |
| import com.fasterxml.jackson.databind.node.ObjectNode; |
| import org.onlab.packet.Ip4Address; |
| import org.onosproject.codec.CodecContext; |
| import org.onosproject.net.PortNumber; |
| import org.onosproject.net.behaviour.ExtensionTreatmentResolver; |
| import org.onosproject.net.driver.AbstractHandlerBehaviour; |
| import org.onosproject.net.flow.instructions.ExtensionTreatment; |
| import org.onosproject.net.flow.instructions.ExtensionTreatmentType; |
| import org.onosproject.openflow.controller.ExtensionTreatmentInterpreter; |
| import org.projectfloodlight.openflow.protocol.OFActionType; |
| import org.projectfloodlight.openflow.protocol.OFFactory; |
| import org.projectfloodlight.openflow.protocol.action.OFAction; |
| import org.projectfloodlight.openflow.protocol.action.OFActionExperimenter; |
| import org.projectfloodlight.openflow.protocol.action.OFActionNicira; |
| import org.projectfloodlight.openflow.protocol.action.OFActionNiciraMove; |
| import org.projectfloodlight.openflow.protocol.action.OFActionNiciraResubmit; |
| import org.projectfloodlight.openflow.protocol.action.OFActionSetField; |
| import org.projectfloodlight.openflow.protocol.oxm.OFOxm; |
| import org.projectfloodlight.openflow.protocol.oxm.OFOxmTunnelIpv4Dst; |
| import org.projectfloodlight.openflow.types.IPv4Address; |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static org.onlab.util.Tools.nullIsIllegal; |
| |
| /** |
| * Interpreter for Nicira OpenFlow treatment extensions. |
| */ |
| public class NiciraExtensionTreatmentInterpreter extends AbstractHandlerBehaviour |
| implements ExtensionTreatmentInterpreter, ExtensionTreatmentResolver { |
| |
| private static final int TYPE_NICIRA = 0x2320; |
| private static final int SRC_ARP_SHA = 0x00012206; |
| private static final int SRC_ARP_SPA = 0x00002004; |
| private static final int SRC_ETH = 0x00000406; |
| private static final int SRC_IP = 0x00000e04; |
| |
| private static final int SUB_TYPE_RESUBMIT = 1; |
| private static final int SUB_TYPE_MOVE = 6; |
| |
| private static final String TUNNEL_DST = "tunnelDst"; |
| private static final String RESUBMIT = "resubmit"; |
| private static final String RESUBMIT_TABLE = "resubmitTable"; |
| private static final String NICIRA_NSH_SPI = "niciraNshSpi"; |
| private static final String NICIRA_NSH_SI = "niciraNshSi"; |
| private static final String NICIRA_NSH_CH = "niciraNshCh"; |
| private static final String NICIRA_MOVE = "niciraMove"; |
| |
| private static final String TYPE = "type"; |
| |
| private static final String MISSING_MEMBER_MESSAGE = " member is required in NiciraExtensionTreatmentInterpreter"; |
| |
| @Override |
| public boolean supported(ExtensionTreatmentType extensionTreatmentType) { |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_TUNNEL_DST.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SPI.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SI.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH1.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH2.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH3.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH4.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT_TABLE.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SHA_TO_THA.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SPA_TO_TPA.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ETH_SRC_TO_DST.type())) { |
| return true; |
| } |
| if (extensionTreatmentType.equals( |
| ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_IP_SRC_TO_DST.type())) { |
| return true; |
| } |
| return false; |
| } |
| |
| @Override |
| public OFAction mapInstruction(OFFactory factory, ExtensionTreatment extensionTreatment) { |
| ExtensionTreatmentType type = extensionTreatment.type(); |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_TUNNEL_DST.type())) { |
| NiciraSetTunnelDst tunnelDst = (NiciraSetTunnelDst) extensionTreatment; |
| return factory.actions().setField(factory.oxms().tunnelIpv4Dst( |
| IPv4Address.of(tunnelDst.tunnelDst().toInt()))); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT.type())) { |
| NiciraResubmit resubmit = (NiciraResubmit) extensionTreatment; |
| return factory.actions().niciraResubmit((int) resubmit.inPort().toLong(), |
| resubmit.table()); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT_TABLE.type())) { |
| NiciraResubmitTable resubmitTable = (NiciraResubmitTable) extensionTreatment; |
| return factory.actions().niciraResubmitTable((int) resubmitTable.inPort().toLong(), |
| resubmitTable.table()); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SHA_TO_THA.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SPA_TO_TPA.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ETH_SRC_TO_DST.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_IP_SRC_TO_DST.type())) { |
| MoveExtensionTreatment mov = (MoveExtensionTreatment) extensionTreatment; |
| OFActionNiciraMove.Builder action = factory.actions() |
| .buildNiciraMove(); |
| action.setDstOfs(mov.dstOffset()); |
| action.setSrcOfs(mov.srcOffset()); |
| action.setNBits(mov.nBits()); |
| action.setSrc(mov.src()); |
| action.setDst(mov.dst()); |
| return action.build(); |
| } |
| return null; |
| } |
| |
| @Override |
| public ExtensionTreatment mapAction(OFAction action) throws UnsupportedOperationException { |
| if (action.getType().equals(OFActionType.SET_FIELD)) { |
| OFActionSetField setFieldAction = (OFActionSetField) action; |
| OFOxm<?> oxm = setFieldAction.getField(); |
| switch (oxm.getMatchField().id) { |
| case TUNNEL_IPV4_DST: |
| OFOxmTunnelIpv4Dst tunnelIpv4Dst = (OFOxmTunnelIpv4Dst) oxm; |
| return new NiciraSetTunnelDst(Ip4Address.valueOf(tunnelIpv4Dst.getValue().getInt())); |
| default: |
| throw new UnsupportedOperationException( |
| "Driver does not support extension type " + oxm.getMatchField().id); |
| } |
| } |
| if (action.getType().equals(OFActionType.EXPERIMENTER)) { |
| OFActionExperimenter experimenter = (OFActionExperimenter) action; |
| if (Long.valueOf(experimenter.getExperimenter()) |
| .intValue() == TYPE_NICIRA) { |
| OFActionNicira nicira = (OFActionNicira) experimenter; |
| switch (nicira.getSubtype()) { |
| case SUB_TYPE_MOVE: |
| OFActionNiciraMove moveAction = (OFActionNiciraMove) nicira; |
| switch (Long.valueOf(moveAction.getSrc()).intValue()) { |
| case SRC_ARP_SHA: |
| return NiciraMoveTreatmentFactory |
| .createNiciraMovArpShaToTha(); |
| case SRC_ETH: |
| return NiciraMoveTreatmentFactory |
| .createNiciraMovEthSrcToDst(); |
| case SRC_IP: |
| return NiciraMoveTreatmentFactory |
| .createNiciraMovIpSrcToDst(); |
| case SRC_ARP_SPA: |
| return NiciraMoveTreatmentFactory |
| .createNiciraMovArpSpaToTpa(); |
| default: |
| throw new UnsupportedOperationException("Driver does not support move from " |
| + moveAction.getSrc() + " to " |
| + moveAction.getDst()); |
| } |
| case SUB_TYPE_RESUBMIT: |
| OFActionNiciraResubmit resubmitAction = (OFActionNiciraResubmit) nicira; |
| return new NiciraResubmit(PortNumber.portNumber(resubmitAction.getInPort())); |
| default: |
| throw new UnsupportedOperationException("Driver does not support extension subtype " |
| + nicira.getSubtype()); |
| } |
| } |
| } |
| return null; |
| } |
| |
| @Override |
| public ExtensionTreatment getExtensionInstruction(ExtensionTreatmentType type) { |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_TUNNEL_DST.type())) { |
| return new NiciraSetTunnelDst(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT.type())) { |
| return new NiciraResubmit(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT_TABLE.type())) { |
| return new NiciraResubmitTable(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SPI.type())) { |
| return new NiciraSetNshSpi(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SI.type())) { |
| return new NiciraSetNshSi(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH1.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH2.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH3.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH4.type())) { |
| return new NiciraSetNshContextHeader(type); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SHA_TO_THA.type())) { |
| return NiciraMoveTreatmentFactory.createNiciraMovArpShaToTha(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SPA_TO_TPA.type())) { |
| return NiciraMoveTreatmentFactory.createNiciraMovArpSpaToTpa(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ETH_SRC_TO_DST.type())) { |
| return NiciraMoveTreatmentFactory.createNiciraMovEthSrcToDst(); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_IP_SRC_TO_DST.type())) { |
| return NiciraMoveTreatmentFactory.createNiciraMovIpSrcToDst(); |
| } |
| throw new UnsupportedOperationException( |
| "Driver does not support extension type " + type.toString()); |
| } |
| |
| @Override |
| public ObjectNode encode(ExtensionTreatment extensionTreatment, CodecContext context) { |
| checkNotNull(extensionTreatment, "Extension treatment cannot be null"); |
| ExtensionTreatmentType type = extensionTreatment.type(); |
| ObjectNode root = context.mapper().createObjectNode(); |
| |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_TUNNEL_DST.type())) { |
| NiciraSetTunnelDst tunnelDst = (NiciraSetTunnelDst) extensionTreatment; |
| root.set(TUNNEL_DST, context.codec(NiciraSetTunnelDst.class).encode(tunnelDst, context)); |
| } |
| |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT.type())) { |
| NiciraResubmit resubmit = (NiciraResubmit) extensionTreatment; |
| root.set(RESUBMIT, context.codec(NiciraResubmit.class).encode(resubmit, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT_TABLE.type())) { |
| NiciraResubmitTable resubmitTable = (NiciraResubmitTable) extensionTreatment; |
| root.set(RESUBMIT_TABLE, context.codec(NiciraResubmitTable.class).encode(resubmitTable, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SPI.type())) { |
| NiciraSetNshSpi niciraNshSpi = (NiciraSetNshSpi) extensionTreatment; |
| root.set(NICIRA_NSH_SPI, context.codec(NiciraSetNshSpi.class).encode(niciraNshSpi, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SI.type())) { |
| NiciraSetNshSi niciraNshSi = (NiciraSetNshSi) extensionTreatment; |
| root.set(NICIRA_NSH_SI, context.codec(NiciraSetNshSi.class).encode(niciraNshSi, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH1.type())) { |
| NiciraSetNshContextHeader niciraNshch = (NiciraSetNshContextHeader) extensionTreatment; |
| root.set(NICIRA_NSH_CH, context.codec(NiciraSetNshContextHeader.class).encode(niciraNshch, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH2.type())) { |
| NiciraSetNshContextHeader niciraNshch = (NiciraSetNshContextHeader) extensionTreatment; |
| root.set(NICIRA_NSH_CH, context.codec(NiciraSetNshContextHeader.class).encode(niciraNshch, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH3.type())) { |
| NiciraSetNshContextHeader niciraNshch = (NiciraSetNshContextHeader) extensionTreatment; |
| root.set(NICIRA_NSH_CH, context.codec(NiciraSetNshContextHeader.class).encode(niciraNshch, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH4.type())) { |
| NiciraSetNshContextHeader niciraNshch = (NiciraSetNshContextHeader) extensionTreatment; |
| root.set(NICIRA_NSH_CH, context.codec(NiciraSetNshContextHeader.class).encode(niciraNshch, context)); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SHA_TO_THA.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SPA_TO_TPA.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ETH_SRC_TO_DST.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_IP_SRC_TO_DST.type())) { |
| MoveExtensionTreatment mov = (MoveExtensionTreatment) extensionTreatment; |
| root.set(NICIRA_MOVE, context.codec(MoveExtensionTreatment.class).encode(mov, context)); |
| } |
| |
| return root; |
| } |
| |
| @Override |
| public ExtensionTreatment decode(ObjectNode json, CodecContext context) { |
| if (json == null || !json.isObject()) { |
| return null; |
| } |
| |
| // parse extension type |
| int typeInt = nullIsIllegal(json.get(TYPE), TYPE + MISSING_MEMBER_MESSAGE).asInt(); |
| ExtensionTreatmentType type = new ExtensionTreatmentType(typeInt); |
| |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_TUNNEL_DST.type())) { |
| return context.codec(NiciraSetTunnelDst.class).decode(json, context); |
| } |
| |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT.type())) { |
| return context.codec(NiciraResubmit.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_RESUBMIT_TABLE.type())) { |
| return context.codec(NiciraResubmitTable.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SPI.type())) { |
| return context.codec(NiciraSetNshSpi.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_SI.type())) { |
| return context.codec(NiciraSetNshSi.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH1.type())) { |
| return context.codec(NiciraSetNshContextHeader.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH2.type())) { |
| return context.codec(NiciraSetNshContextHeader.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH3.type())) { |
| return context.codec(NiciraSetNshContextHeader.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_SET_NSH_CH4.type())) { |
| return context.codec(NiciraSetNshContextHeader.class).decode(json, context); |
| } |
| if (type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SHA_TO_THA.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ARP_SPA_TO_TPA.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_ETH_SRC_TO_DST.type()) |
| || type.equals(ExtensionTreatmentType.ExtensionTreatmentTypes.NICIRA_MOV_IP_SRC_TO_DST.type())) { |
| return context.codec(MoveExtensionTreatment.class).decode(json, context); |
| } |
| throw new UnsupportedOperationException( |
| "Driver does not support extension type " + type.toString()); |
| } |
| } |