Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.pipelines.fabric; |
| 18 | |
| 19 | import com.google.common.collect.ImmutableList; |
| 20 | import org.onlab.packet.MacAddress; |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 21 | import org.onlab.packet.MplsLabel; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 22 | import org.onlab.packet.VlanId; |
| 23 | import org.onlab.util.ImmutableByteSequence; |
| 24 | import org.onosproject.net.PortNumber; |
Yi Tseng | df3eec5 | 2018-02-15 14:56:02 -0800 | [diff] [blame] | 25 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 26 | import org.onosproject.net.flow.TrafficTreatment; |
| 27 | import org.onosproject.net.flow.instructions.Instruction; |
| 28 | import org.onosproject.net.flow.instructions.Instructions; |
| 29 | import org.onosproject.net.flow.instructions.Instructions.OutputInstruction; |
| 30 | import org.onosproject.net.flow.instructions.L2ModificationInstruction; |
| 31 | import org.onosproject.net.flow.instructions.L2ModificationInstruction.ModEtherInstruction; |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 32 | import org.onosproject.net.flow.instructions.L2ModificationInstruction.ModMplsLabelInstruction; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 33 | import org.onosproject.net.flow.instructions.L2ModificationInstruction.ModVlanIdInstruction; |
| 34 | import org.onosproject.net.pi.model.PiActionId; |
| 35 | import org.onosproject.net.pi.model.PiPipelineInterpreter.PiInterpreterException; |
| 36 | import org.onosproject.net.pi.runtime.PiAction; |
| 37 | import org.onosproject.net.pi.runtime.PiActionParam; |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 38 | import org.slf4j.Logger; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 39 | |
| 40 | import java.util.List; |
| 41 | |
| 42 | import static java.lang.String.format; |
| 43 | import static org.onosproject.net.flow.instructions.Instruction.Type.L2MODIFICATION; |
| 44 | import static org.onosproject.net.flow.instructions.Instruction.Type.OUTPUT; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 45 | import static org.onosproject.net.flow.instructions.L2ModificationInstruction.L2SubType.VLAN_ID; |
| 46 | import static org.onosproject.net.flow.instructions.L2ModificationInstruction.L2SubType.VLAN_PUSH; |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 47 | import static org.slf4j.LoggerFactory.getLogger; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 48 | |
| 49 | |
| 50 | final class FabricTreatmentInterpreter { |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 51 | private static final Logger log = getLogger(FabricTreatmentInterpreter.class); |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 52 | private static final String INVALID_TREATMENT = "Invalid treatment for %s block: %s"; |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 53 | private static final PiAction NOP = PiAction.builder() |
| 54 | .withId(FabricConstants.ACT_NOP_ID) |
| 55 | .build(); |
| 56 | |
| 57 | private static final PiAction POP_VLAN = PiAction.builder() |
| 58 | .withId(FabricConstants.ACT_FABRICEGRESS_EGRESS_NEXT_POP_VLAN_ID) |
| 59 | .build(); |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 60 | |
| 61 | // Hide default constructor |
| 62 | protected FabricTreatmentInterpreter() { |
| 63 | } |
| 64 | |
| 65 | /* |
| 66 | * In Filtering block, we need to implement these actions: |
| 67 | * |
| 68 | * push_internal_vlan |
| 69 | * set_vlan |
| 70 | * nop |
| 71 | * |
| 72 | * Unsupported, using PiAction directly: |
| 73 | * set_forwarding_type |
| 74 | */ |
| 75 | |
| 76 | static PiAction mapFilteringTreatment(TrafficTreatment treatment) |
| 77 | throws PiInterpreterException { |
| 78 | List<Instruction> instructions = treatment.allInstructions(); |
| 79 | Instruction noActInst = Instructions.createNoAction(); |
| 80 | if (instructions.isEmpty() || instructions.contains(noActInst)) { |
| 81 | // nop |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 82 | return NOP; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | L2ModificationInstruction.ModVlanHeaderInstruction pushVlanInst = null; |
| 86 | ModVlanIdInstruction setVlanInst = null; |
| 87 | |
| 88 | for (Instruction inst : instructions) { |
| 89 | if (inst.type() == L2MODIFICATION) { |
| 90 | L2ModificationInstruction l2Inst = (L2ModificationInstruction) inst; |
| 91 | |
| 92 | if (l2Inst.subtype() == VLAN_PUSH) { |
| 93 | pushVlanInst = (L2ModificationInstruction.ModVlanHeaderInstruction) l2Inst; |
| 94 | |
| 95 | } else if (l2Inst.subtype() == VLAN_ID) { |
| 96 | setVlanInst = (ModVlanIdInstruction) l2Inst; |
| 97 | } |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | if (setVlanInst == null) { |
| 102 | throw new PiInterpreterException(format(INVALID_TREATMENT, "filtering", treatment)); |
| 103 | } |
| 104 | |
| 105 | VlanId vlanId = setVlanInst.vlanId(); |
| 106 | PiActionParam param = new PiActionParam(FabricConstants.ACT_PRM_NEW_VLAN_ID_ID, |
| 107 | ImmutableByteSequence.copyFrom(vlanId.toShort())); |
| 108 | PiActionId actionId; |
| 109 | if (pushVlanInst != null) { |
| 110 | // push_internal_vlan |
Yi Tseng | 27b9bc0 | 2018-04-12 14:52:40 +0800 | [diff] [blame] | 111 | actionId = FabricConstants.ACT_FABRICINGRESS_FILTERING_PUSH_INTERNAL_VLAN_ID; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 112 | } else { |
Yi Tseng | 27b9bc0 | 2018-04-12 14:52:40 +0800 | [diff] [blame] | 113 | actionId = FabricConstants.ACT_FABRICINGRESS_FILTERING_SET_VLAN_ID; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | // set_vlan |
| 117 | return PiAction.builder() |
| 118 | .withId(actionId) |
| 119 | .withParameter(param) |
| 120 | .build(); |
| 121 | } |
| 122 | |
| 123 | /* |
| 124 | * In forwarding block, we need to implement these actions: |
| 125 | * duplicate_to_controller |
| 126 | * |
| 127 | * Unsupported, using PiAction directly: |
| 128 | * set_next_id |
| 129 | * push_mpls_and_next_v4 |
| 130 | * push_mpls_and_next_v6 |
| 131 | */ |
| 132 | |
| 133 | public static PiAction mapForwardingTreatment(TrafficTreatment treatment) |
| 134 | throws PiInterpreterException { |
Yi Tseng | df3eec5 | 2018-02-15 14:56:02 -0800 | [diff] [blame] | 135 | // Empty treatment, generate table entry with no action |
| 136 | if (treatment.equals(DefaultTrafficTreatment.emptyTreatment())) { |
| 137 | return null; |
| 138 | } |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 139 | List<Instruction> insts = treatment.allInstructions(); |
| 140 | OutputInstruction outInst = insts.stream() |
| 141 | .filter(inst -> inst.type() == OUTPUT) |
| 142 | .map(inst -> (OutputInstruction) inst) |
| 143 | .findFirst() |
| 144 | .orElse(null); |
| 145 | |
| 146 | if (outInst == null) { |
| 147 | throw new PiInterpreterException(format(INVALID_TREATMENT, "forwarding", treatment)); |
| 148 | } |
| 149 | |
| 150 | PortNumber portNumber = outInst.port(); |
| 151 | if (!portNumber.equals(PortNumber.CONTROLLER)) { |
| 152 | throw new PiInterpreterException(format("Unsupported port number %s," + |
| 153 | "supports punt action only", |
| 154 | portNumber)); |
| 155 | } |
| 156 | |
| 157 | return PiAction.builder() |
Yi Tseng | 27b9bc0 | 2018-04-12 14:52:40 +0800 | [diff] [blame] | 158 | .withId(FabricConstants.ACT_FABRICINGRESS_FORWARDING_DUPLICATE_TO_CONTROLLER_ID) |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 159 | .build(); |
| 160 | } |
| 161 | |
| 162 | /* |
| 163 | * In Next block, we need to implement these actions: |
| 164 | * output |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 165 | * set_vlan_output |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 166 | * l3_routing |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 167 | * l3_routing_vlan |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 168 | * mpls_routing_v4 |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 169 | * |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 170 | * Unsupported, need to find a way to implement it |
| 171 | * mpls_routing_v6 |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 172 | */ |
| 173 | |
| 174 | public static PiAction mapNextTreatment(TrafficTreatment treatment) |
| 175 | throws PiInterpreterException { |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 176 | // TODO: refactor this method |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 177 | List<Instruction> insts = treatment.allInstructions(); |
| 178 | OutputInstruction outInst = null; |
| 179 | ModEtherInstruction modEthDstInst = null; |
| 180 | ModEtherInstruction modEthSrcInst = null; |
| 181 | ModVlanIdInstruction modVlanIdInst = null; |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 182 | ModMplsLabelInstruction modMplsInst = null; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 183 | |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 184 | // TODO: add NextFunctionType (like ForwardingFunctionType) |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 185 | for (Instruction inst : insts) { |
| 186 | switch (inst.type()) { |
| 187 | case L2MODIFICATION: |
| 188 | L2ModificationInstruction l2Inst = (L2ModificationInstruction) inst; |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 189 | switch (l2Inst.subtype()) { |
| 190 | case ETH_SRC: |
| 191 | modEthSrcInst = (ModEtherInstruction) l2Inst; |
| 192 | break; |
| 193 | case ETH_DST: |
| 194 | modEthDstInst = (ModEtherInstruction) l2Inst; |
| 195 | break; |
| 196 | case VLAN_ID: |
| 197 | modVlanIdInst = (ModVlanIdInstruction) l2Inst; |
| 198 | break; |
| 199 | case MPLS_LABEL: |
| 200 | modMplsInst = (ModMplsLabelInstruction) l2Inst; |
| 201 | break; |
| 202 | default: |
| 203 | log.warn("Unsupported l2 instruction sub type: {}", l2Inst.subtype()); |
| 204 | break; |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 205 | } |
| 206 | break; |
| 207 | case OUTPUT: |
| 208 | outInst = (OutputInstruction) inst; |
| 209 | break; |
| 210 | default: |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 211 | log.warn("Unsupported instruction sub type: {}", inst.type()); |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 212 | break; |
| 213 | } |
| 214 | } |
| 215 | |
| 216 | if (outInst == null) { |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 217 | // for vlan_meta table only |
| 218 | if (modVlanIdInst != null) { |
| 219 | // set_vlan |
| 220 | VlanId vlanId = modVlanIdInst.vlanId(); |
| 221 | PiActionParam newVlanParam = |
| 222 | new PiActionParam(FabricConstants.ACT_PRM_NEW_VLAN_ID_ID, |
| 223 | ImmutableByteSequence.copyFrom(vlanId.toShort())); |
| 224 | // set_vlan_output |
| 225 | return PiAction.builder() |
| 226 | .withId(FabricConstants.ACT_FABRICINGRESS_NEXT_SET_VLAN_ID) |
| 227 | .withParameter(newVlanParam) |
| 228 | .build(); |
| 229 | } else { |
| 230 | throw new PiInterpreterException(format(INVALID_TREATMENT, "next", treatment)); |
| 231 | } |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 232 | } |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 233 | |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 234 | short portNum = (short) outInst.port().toLong(); |
| 235 | PiActionParam portNumParam = new PiActionParam(FabricConstants.ACT_PRM_PORT_NUM_ID, |
| 236 | ImmutableByteSequence.copyFrom(portNum)); |
| 237 | if (modEthDstInst == null && modEthSrcInst == null) { |
| 238 | if (modVlanIdInst != null) { |
| 239 | VlanId vlanId = modVlanIdInst.vlanId(); |
| 240 | PiActionParam vlanParam = |
| 241 | new PiActionParam(FabricConstants.ACT_PRM_NEW_VLAN_ID_ID, |
| 242 | ImmutableByteSequence.copyFrom(vlanId.toShort())); |
| 243 | // set_vlan_output |
| 244 | return PiAction.builder() |
Yi Tseng | 27b9bc0 | 2018-04-12 14:52:40 +0800 | [diff] [blame] | 245 | .withId(FabricConstants.ACT_FABRICINGRESS_NEXT_SET_VLAN_OUTPUT_ID) |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 246 | .withParameters(ImmutableList.of(portNumParam, vlanParam)) |
| 247 | .build(); |
| 248 | } else { |
| 249 | // output |
| 250 | return PiAction.builder() |
Yi Tseng | 27b9bc0 | 2018-04-12 14:52:40 +0800 | [diff] [blame] | 251 | .withId(FabricConstants.ACT_FABRICINGRESS_NEXT_OUTPUT_ID) |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 252 | .withParameter(portNumParam) |
| 253 | .build(); |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | if (modEthDstInst != null && modEthSrcInst != null) { |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 258 | MacAddress srcMac = modEthSrcInst.mac(); |
| 259 | MacAddress dstMac = modEthDstInst.mac(); |
| 260 | PiActionParam srcMacParam = new PiActionParam(FabricConstants.ACT_PRM_SMAC_ID, |
| 261 | ImmutableByteSequence.copyFrom(srcMac.toBytes())); |
| 262 | PiActionParam dstMacParam = new PiActionParam(FabricConstants.ACT_PRM_DMAC_ID, |
| 263 | ImmutableByteSequence.copyFrom(dstMac.toBytes())); |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 264 | |
| 265 | if (modMplsInst != null) { |
| 266 | // MPLS routing |
| 267 | MplsLabel mplsLabel = modMplsInst.label(); |
| 268 | try { |
| 269 | ImmutableByteSequence mplsValue = |
Carmelo Cascone | 8a571af | 2018-04-06 23:17:04 -0700 | [diff] [blame] | 270 | ImmutableByteSequence.copyFrom(mplsLabel.toInt()).fit(20); |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 271 | PiActionParam mplsParam = new PiActionParam(FabricConstants.ACT_PRM_LABEL_ID, mplsValue); |
| 272 | return PiAction.builder() |
| 273 | // FIXME: fins a way to determine v4 or v6 |
Yi Tseng | 27b9bc0 | 2018-04-12 14:52:40 +0800 | [diff] [blame] | 274 | .withId(FabricConstants.ACT_FABRICINGRESS_NEXT_MPLS_ROUTING_V4_ID) |
Yi Tseng | 1b154bd | 2017-11-20 17:48:19 -0800 | [diff] [blame] | 275 | .withParameters(ImmutableList.of(portNumParam, |
| 276 | srcMacParam, |
| 277 | dstMacParam, |
| 278 | mplsParam)) |
| 279 | .build(); |
| 280 | } catch (ImmutableByteSequence.ByteSequenceTrimException e) { |
| 281 | // Basically this won't happened because we already limited |
| 282 | // size of mpls value to 20 bits (0xFFFFF) |
| 283 | throw new PiInterpreterException(format(INVALID_TREATMENT, "next", treatment)); |
| 284 | } |
| 285 | } |
| 286 | |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 287 | if (modVlanIdInst != null) { |
| 288 | VlanId vlanId = modVlanIdInst.vlanId(); |
| 289 | PiActionParam vlanParam = |
| 290 | new PiActionParam(FabricConstants.ACT_PRM_NEW_VLAN_ID_ID, |
| 291 | ImmutableByteSequence.copyFrom(vlanId.toShort())); |
| 292 | // L3 routing and set VLAN |
| 293 | return PiAction.builder() |
| 294 | .withId(FabricConstants.ACT_FABRICINGRESS_NEXT_L3_ROUTING_VLAN_ID) |
| 295 | .withParameters(ImmutableList.of(srcMacParam, dstMacParam, portNumParam, vlanParam)) |
| 296 | .build(); |
| 297 | } else { |
| 298 | // L3 routing |
| 299 | return PiAction.builder() |
| 300 | .withId(FabricConstants.ACT_FABRICINGRESS_NEXT_L3_ROUTING_ID) |
| 301 | .withParameters(ImmutableList.of(portNumParam, |
| 302 | srcMacParam, |
| 303 | dstMacParam)) |
| 304 | .build(); |
| 305 | } |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | throw new PiInterpreterException(format(INVALID_TREATMENT, "next", treatment)); |
| 309 | } |
Yi Tseng | 20f9e7b | 2018-05-24 23:27:39 +0800 | [diff] [blame] | 310 | |
| 311 | public static PiAction mapEgressNextTreatment(TrafficTreatment treatment) { |
| 312 | // Pop VLAN action for now, may add new action to this control block in the future. |
| 313 | return treatment.allInstructions() |
| 314 | .stream() |
| 315 | .filter(inst -> inst.type() == Instruction.Type.L2MODIFICATION) |
| 316 | .map(inst -> (L2ModificationInstruction) inst) |
| 317 | .filter(inst -> inst.subtype() == L2ModificationInstruction.L2SubType.VLAN_POP) |
| 318 | .findFirst() |
| 319 | .map(inst -> POP_VLAN) |
| 320 | .orElse(NOP); |
| 321 | } |
Yi Tseng | fa4a1c7 | 2017-11-03 10:22:38 -0700 | [diff] [blame] | 322 | } |