Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 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.net.pi.impl; |
| 18 | |
| 19 | import com.google.common.collect.ImmutableMap; |
| 20 | import org.apache.commons.lang3.tuple.Pair; |
| 21 | import org.onlab.util.ImmutableByteSequence; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 22 | import org.onosproject.net.flow.criteria.ArpHaCriterion; |
| 23 | import org.onosproject.net.flow.criteria.ArpOpCriterion; |
| 24 | import org.onosproject.net.flow.criteria.ArpPaCriterion; |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 25 | import org.onosproject.net.flow.criteria.Criterion; |
| 26 | import org.onosproject.net.flow.criteria.EthCriterion; |
| 27 | import org.onosproject.net.flow.criteria.EthTypeCriterion; |
| 28 | import org.onosproject.net.flow.criteria.IPCriterion; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 29 | import org.onosproject.net.flow.criteria.IPDscpCriterion; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 30 | import org.onosproject.net.flow.criteria.IPEcnCriterion; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 31 | import org.onosproject.net.flow.criteria.IPProtocolCriterion; |
| 32 | import org.onosproject.net.flow.criteria.IPv6ExthdrFlagsCriterion; |
| 33 | import org.onosproject.net.flow.criteria.IPv6FlowLabelCriterion; |
| 34 | import org.onosproject.net.flow.criteria.IPv6NDLinkLayerAddressCriterion; |
| 35 | import org.onosproject.net.flow.criteria.IPv6NDTargetAddressCriterion; |
| 36 | import org.onosproject.net.flow.criteria.IcmpCodeCriterion; |
| 37 | import org.onosproject.net.flow.criteria.IcmpTypeCriterion; |
| 38 | import org.onosproject.net.flow.criteria.Icmpv6CodeCriterion; |
| 39 | import org.onosproject.net.flow.criteria.Icmpv6TypeCriterion; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 40 | import org.onosproject.net.flow.criteria.MetadataCriterion; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 41 | import org.onosproject.net.flow.criteria.MplsBosCriterion; |
| 42 | import org.onosproject.net.flow.criteria.MplsCriterion; |
| 43 | import org.onosproject.net.flow.criteria.MplsTcCriterion; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 44 | import org.onosproject.net.flow.criteria.PbbIsidCriterion; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 45 | import org.onosproject.net.flow.criteria.PortCriterion; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 46 | import org.onosproject.net.flow.criteria.SctpPortCriterion; |
| 47 | import org.onosproject.net.flow.criteria.TcpFlagsCriterion; |
| 48 | import org.onosproject.net.flow.criteria.TcpPortCriterion; |
| 49 | import org.onosproject.net.flow.criteria.TunnelIdCriterion; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 50 | import org.onosproject.net.flow.criteria.UdpPortCriterion; |
| 51 | import org.onosproject.net.flow.criteria.VlanIdCriterion; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 52 | import org.onosproject.net.flow.criteria.VlanPcpCriterion; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 53 | import org.onosproject.net.pi.impl.CriterionTranslators.ArpHaCriterionTranslator; |
| 54 | import org.onosproject.net.pi.impl.CriterionTranslators.ArpOpCriterionTranslator; |
| 55 | import org.onosproject.net.pi.impl.CriterionTranslators.ArpPaCriterionTranslator; |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 56 | import org.onosproject.net.pi.impl.CriterionTranslators.EthCriterionTranslator; |
| 57 | import org.onosproject.net.pi.impl.CriterionTranslators.EthTypeCriterionTranslator; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 58 | import org.onosproject.net.pi.impl.CriterionTranslators.IPDscpCriterionTranslator; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 59 | import org.onosproject.net.pi.impl.CriterionTranslators.IPEcnCriterionTranslator; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 60 | import org.onosproject.net.pi.impl.CriterionTranslators.IPProtocolCriterionTranslator; |
| 61 | import org.onosproject.net.pi.impl.CriterionTranslators.IPv6ExthdrFlagsCriterionTranslator; |
| 62 | import org.onosproject.net.pi.impl.CriterionTranslators.IPv6FlowLabelCriterionTranslator; |
| 63 | import org.onosproject.net.pi.impl.CriterionTranslators.IPv6NDLinkLayerAddressCriterionTranslator; |
| 64 | import org.onosproject.net.pi.impl.CriterionTranslators.IPv6NDTargetAddressCriterionTranslator; |
| 65 | import org.onosproject.net.pi.impl.CriterionTranslators.IcmpCodeCriterionTranslator; |
| 66 | import org.onosproject.net.pi.impl.CriterionTranslators.IcmpTypeCriterionTranslator; |
| 67 | import org.onosproject.net.pi.impl.CriterionTranslators.Icmpv6CodeCriterionTranslator; |
| 68 | import org.onosproject.net.pi.impl.CriterionTranslators.Icmpv6TypeCriterionTranslator; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 69 | import org.onosproject.net.pi.impl.CriterionTranslators.IpCriterionTranslator; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 70 | import org.onosproject.net.pi.impl.CriterionTranslators.MetadataCriterionTranslator; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 71 | import org.onosproject.net.pi.impl.CriterionTranslators.MplsBosCriterionTranslator; |
| 72 | import org.onosproject.net.pi.impl.CriterionTranslators.MplsCriterionTranslator; |
| 73 | import org.onosproject.net.pi.impl.CriterionTranslators.MplsTcCriterionTranslator; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 74 | import org.onosproject.net.pi.impl.CriterionTranslators.PbbIsidCriterionTranslator; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 75 | import org.onosproject.net.pi.impl.CriterionTranslators.PortCriterionTranslator; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 76 | import org.onosproject.net.pi.impl.CriterionTranslators.SctpPortCriterionTranslator; |
| 77 | import org.onosproject.net.pi.impl.CriterionTranslators.TcpFlagsCriterionTranslator; |
| 78 | import org.onosproject.net.pi.impl.CriterionTranslators.TcpPortCriterionTranslator; |
| 79 | import org.onosproject.net.pi.impl.CriterionTranslators.TunnelIdCriterionTranslator; |
Carmelo Cascone | 3bf5157 | 2017-07-13 17:16:42 -0400 | [diff] [blame] | 80 | import org.onosproject.net.pi.impl.CriterionTranslators.UdpPortCriterionTranslator; |
| 81 | import org.onosproject.net.pi.impl.CriterionTranslators.VlanIdCriterionTranslator; |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 82 | import org.onosproject.net.pi.impl.CriterionTranslators.VlanPcpCriterionTranslator; |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 83 | import org.onosproject.net.pi.model.PiMatchType; |
| 84 | import org.onosproject.net.pi.runtime.PiExactFieldMatch; |
| 85 | import org.onosproject.net.pi.runtime.PiFieldMatch; |
| 86 | import org.onosproject.net.pi.runtime.PiHeaderFieldId; |
| 87 | import org.onosproject.net.pi.runtime.PiLpmFieldMatch; |
| 88 | import org.onosproject.net.pi.runtime.PiTernaryFieldMatch; |
| 89 | |
| 90 | import java.util.Map; |
| 91 | |
| 92 | import static java.lang.String.format; |
| 93 | import static org.onlab.util.ImmutableByteSequence.ByteSequenceTrimException; |
| 94 | import static org.onosproject.net.pi.impl.CriterionTranslator.CriterionTranslatorException; |
| 95 | import static org.onosproject.net.pi.runtime.PiFlowRuleTranslationService.PiFlowRuleTranslationException; |
| 96 | |
| 97 | /** |
| 98 | * Helper class to translate criterion instances to PI field matches. |
| 99 | */ |
| 100 | final class CriterionTranslatorHelper { |
zhiyong ke | 1667fbb | 2017-07-04 09:51:24 +0800 | [diff] [blame] | 101 | private static final Map<Class<? extends Criterion>, CriterionTranslator> TRANSLATORS = |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 102 | // Add here new CriterionTranslator implementations. |
zhiyong ke | 1667fbb | 2017-07-04 09:51:24 +0800 | [diff] [blame] | 103 | new ImmutableMap.Builder<Class<? extends Criterion>, CriterionTranslator>() |
| 104 | .put(PortCriterion.class, new PortCriterionTranslator()) |
| 105 | .put(EthCriterion.class, new EthCriterionTranslator()) |
| 106 | .put(EthTypeCriterion.class, new EthTypeCriterionTranslator()) |
| 107 | .put(IPCriterion.class, new IpCriterionTranslator()) |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 108 | .put(VlanIdCriterion.class, new VlanIdCriterionTranslator()) |
| 109 | .put(UdpPortCriterion.class, new UdpPortCriterionTranslator()) |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 110 | .put(IPDscpCriterion.class, new IPDscpCriterionTranslator()) |
| 111 | .put(IPProtocolCriterion.class, new IPProtocolCriterionTranslator()) |
| 112 | .put(IPv6ExthdrFlagsCriterion.class, new IPv6ExthdrFlagsCriterionTranslator()) |
| 113 | .put(IPv6FlowLabelCriterion.class, new IPv6FlowLabelCriterionTranslator()) |
| 114 | .put(IPv6NDLinkLayerAddressCriterion.class, new IPv6NDLinkLayerAddressCriterionTranslator()) |
| 115 | .put(IPv6NDTargetAddressCriterion.class, new IPv6NDTargetAddressCriterionTranslator()) |
| 116 | .put(IcmpCodeCriterion.class, new IcmpCodeCriterionTranslator()) |
| 117 | .put(IcmpTypeCriterion.class, new IcmpTypeCriterionTranslator()) |
| 118 | .put(Icmpv6CodeCriterion.class, new Icmpv6CodeCriterionTranslator()) |
| 119 | .put(Icmpv6TypeCriterion.class, new Icmpv6TypeCriterionTranslator()) |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 120 | .put(MplsBosCriterion.class, new MplsBosCriterionTranslator()) |
| 121 | .put(MplsCriterion.class, new MplsCriterionTranslator()) |
| 122 | .put(MplsTcCriterion.class, new MplsTcCriterionTranslator()) |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 123 | .put(PbbIsidCriterion.class, new PbbIsidCriterionTranslator()) |
zhiyong ke | f2e6a48 | 2017-07-10 20:32:20 +0800 | [diff] [blame] | 124 | .put(SctpPortCriterion.class, new SctpPortCriterionTranslator()) |
| 125 | .put(TcpFlagsCriterion.class, new TcpFlagsCriterionTranslator()) |
| 126 | .put(TcpPortCriterion.class, new TcpPortCriterionTranslator()) |
| 127 | .put(TunnelIdCriterion.class, new TunnelIdCriterionTranslator()) |
| 128 | .put(VlanPcpCriterion.class, new VlanPcpCriterionTranslator()) |
| 129 | .put(ArpHaCriterion.class, new ArpHaCriterionTranslator()) |
| 130 | .put(ArpOpCriterion.class, new ArpOpCriterionTranslator()) |
| 131 | .put(ArpPaCriterion.class, new ArpPaCriterionTranslator()) |
zhiyong ke | 897fd2d | 2017-07-12 11:41:38 +0800 | [diff] [blame] | 132 | .put(IPEcnCriterion.class, new IPEcnCriterionTranslator()) |
| 133 | .put(MetadataCriterion.class, new MetadataCriterionTranslator()) |
zhiyong ke | 1667fbb | 2017-07-04 09:51:24 +0800 | [diff] [blame] | 134 | .build(); |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 135 | |
| 136 | private CriterionTranslatorHelper() { |
| 137 | // Hides constructor. |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Translates a given criterion instance to a PiFieldMatch with the given id, match type, and bit-width. |
| 142 | * |
| 143 | * @param fieldId PI header field identifier |
| 144 | * @param criterion criterion |
| 145 | * @param matchType match type |
| 146 | * @param bitWidth size of the field match in bits |
| 147 | * @return a PI field match |
| 148 | * @throws PiFlowRuleTranslationException if the criterion cannot be translated (see exception message) |
| 149 | */ |
| 150 | static PiFieldMatch translateCriterion(Criterion criterion, PiHeaderFieldId fieldId, PiMatchType matchType, |
| 151 | int bitWidth) |
| 152 | throws PiFlowRuleTranslationException { |
| 153 | |
| 154 | if (!TRANSLATORS.containsKey(criterion.getClass())) { |
| 155 | throw new PiFlowRuleTranslationException(format( |
| 156 | "Translation of criterion class %s is not implemented.", |
| 157 | criterion.getClass().getSimpleName())); |
| 158 | } |
| 159 | |
| 160 | CriterionTranslator translator = TRANSLATORS.get(criterion.getClass()); |
| 161 | |
| 162 | try { |
| 163 | translator.init(criterion, bitWidth); |
| 164 | switch (matchType) { |
| 165 | case EXACT: |
| 166 | return new PiExactFieldMatch(fieldId, translator.exactMatch()); |
| 167 | case TERNARY: |
| 168 | Pair<ImmutableByteSequence, ImmutableByteSequence> tp = translator.ternaryMatch(); |
| 169 | return new PiTernaryFieldMatch(fieldId, tp.getLeft(), tp.getRight()); |
| 170 | case LPM: |
| 171 | Pair<ImmutableByteSequence, Integer> lp = translator.lpmMatch(); |
| 172 | return new PiLpmFieldMatch(fieldId, lp.getLeft(), lp.getRight()); |
| 173 | default: |
| 174 | throw new PiFlowRuleTranslationException(format( |
| 175 | "Translation of criterion %s (%s class) to match type %s is not implemented.", |
| 176 | criterion.type().name(), criterion.getClass().getSimpleName(), matchType.name())); |
| 177 | } |
| 178 | } catch (ByteSequenceTrimException e) { |
| 179 | throw new PiFlowRuleTranslationException(format( |
| 180 | "Size mismatch for criterion %s: %s", criterion.type(), e.getMessage())); |
| 181 | } catch (CriterionTranslatorException e) { |
| 182 | throw new PiFlowRuleTranslationException(format( |
| 183 | "Unable to translate criterion %s: %s", criterion.type(), e.getMessage())); |
| 184 | } |
| 185 | } |
| 186 | } |