Add Optional match fields support to PI subsystem
Change-Id: Ic458f59cab98340e40c04a0ad060d3c725ac5dbb
diff --git a/protocols/p4runtime/ctl/src/test/java/org/onosproject/p4runtime/ctl/codec/TableEntryEncoderTest.java b/protocols/p4runtime/ctl/src/test/java/org/onosproject/p4runtime/ctl/codec/TableEntryEncoderTest.java
index c213753..8614527 100644
--- a/protocols/p4runtime/ctl/src/test/java/org/onosproject/p4runtime/ctl/codec/TableEntryEncoderTest.java
+++ b/protocols/p4runtime/ctl/src/test/java/org/onosproject/p4runtime/ctl/codec/TableEntryEncoderTest.java
@@ -34,19 +34,24 @@
import org.onosproject.net.pi.runtime.PiCounterCellData;
import org.onosproject.net.pi.runtime.PiExactFieldMatch;
import org.onosproject.net.pi.runtime.PiMatchKey;
+import org.onosproject.net.pi.runtime.PiOptionalFieldMatch;
import org.onosproject.net.pi.runtime.PiTableEntry;
import org.onosproject.net.pi.runtime.PiTernaryFieldMatch;
import org.onosproject.p4runtime.ctl.utils.P4InfoBrowser;
import org.onosproject.p4runtime.ctl.utils.PipeconfHelper;
+import p4.v1.P4RuntimeOuterClass;
import p4.v1.P4RuntimeOuterClass.Action;
import p4.v1.P4RuntimeOuterClass.CounterData;
import p4.v1.P4RuntimeOuterClass.TableEntry;
import java.net.URL;
import java.util.Random;
+import java.util.stream.Collectors;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.not;
+import static org.hamcrest.Matchers.hasItem;
import static org.onlab.util.ImmutableByteSequence.copyFrom;
import static org.onlab.util.ImmutableByteSequence.ofOnes;
import static org.onosproject.net.pi.model.PiPipeconf.ExtensionType.P4_INFO_TEXT;
@@ -92,6 +97,7 @@
.build();
private final P4InfoBrowser browser = PipeconfHelper.getP4InfoBrowser(defaultPipeconf);
+ private final P4InfoBrowser browser2 = PipeconfHelper.getP4InfoBrowser(defaultPipeconf2);
private final ImmutableByteSequence ethAddr = copyFrom(rand.nextInt()).fit(48);
private final ImmutableByteSequence ethAddrString = ImmutableByteSequence.copyFrom(
"00:11:22:33:44:55:66".getBytes());
@@ -139,7 +145,7 @@
.addFieldMatch(new PiExactFieldMatch(inPortFieldId2, portValue32Bit))
.addFieldMatch(new PiExactFieldMatch(ethDstAddrFieldId, ethAddrString))
.addFieldMatch(new PiExactFieldMatch(ethSrcAddrFieldId, ethAddrString))
- .addFieldMatch(new PiExactFieldMatch(ethTypeFieldId, portValue))
+ .addFieldMatch(new PiOptionalFieldMatch(ethTypeFieldId, portValue))
.build())
.withAction(PiAction
.builder()
@@ -157,7 +163,7 @@
.addFieldMatch(new PiExactFieldMatch(inPortFieldId2, portValue32Bit))
.addFieldMatch(new PiExactFieldMatch(ethDstAddrFieldId, ethAddrString))
.addFieldMatch(new PiExactFieldMatch(ethSrcAddrFieldId, ethAddrString))
- .addFieldMatch(new PiExactFieldMatch(ethTypeFieldId, portValue))
+ .addFieldMatch(new PiOptionalFieldMatch(ethTypeFieldId, portValue))
.build())
.withAction(PiAction
.builder()
@@ -168,6 +174,23 @@
.withCookie(2)
.build();
+ private final PiTableEntry piTableEntryWithoutOptionalField = PiTableEntry
+ .builder()
+ .forTable(tableId)
+ .withMatchKey(PiMatchKey.builder()
+ .addFieldMatch(new PiExactFieldMatch(inPortFieldId2, portValue32Bit))
+ .addFieldMatch(new PiExactFieldMatch(ethDstAddrFieldId, ethAddrString))
+ .addFieldMatch(new PiExactFieldMatch(ethSrcAddrFieldId, ethAddrString))
+ .build())
+ .withAction(PiAction
+ .builder()
+ .withId(outActionId)
+ .withParameter(new PiActionParam(portParamId, portValueString))
+ .build())
+ .withPriority(1)
+ .withCookie(2)
+ .build();
+
private final PiTableEntry piTableEntryWithoutAction = PiTableEntry
.builder()
.forTable(tableId)
@@ -294,6 +317,31 @@
}
@Test
+ public void testTableEntryEncoderWithoutOptionalField() throws Exception {
+ TableEntry tableEntryMsg = Codecs.CODECS.tableEntry().encode(
+ piTableEntryWithoutOptionalField, null, defaultPipeconf2);
+ PiTableEntry decodedPiTableEntry = Codecs.CODECS.tableEntry().decode(
+ tableEntryMsg, null, defaultPipeconf2);
+
+ // Table ID.
+ int p4InfoTableId = browser2.tables().getByName(tableId.id()).getPreamble().getId();
+ int encodedTableId = tableEntryMsg.getTableId();
+ assertThat(encodedTableId, is(p4InfoTableId));
+
+ // Test equality for decoded entry.
+ new EqualsTester()
+ .addEqualityGroup(piTableEntryWithoutOptionalField, decodedPiTableEntry)
+ .testEquals();
+
+ // no optional field
+ assertThat(tableEntryMsg.getMatchCount(), is(3));
+ assertThat(tableEntryMsg.getMatchList().stream()
+ .map(P4RuntimeOuterClass.FieldMatch::getFieldMatchTypeCase)
+ .collect(Collectors.toList()),
+ not(hasItem(P4RuntimeOuterClass.FieldMatch.FieldMatchTypeCase.OPTIONAL)));
+ }
+
+ @Test
public void testActopProfileGroup() throws Exception {
TableEntry tableEntryMsg = Codecs.CODECS.tableEntry().encode(
piTableEntryWithGroupAction, null, defaultPipeconf);
diff --git a/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation.p4 b/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation.p4
index 6ebf306..7f5431c 100644
--- a/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation.p4
+++ b/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation.p4
@@ -130,7 +130,7 @@
local_metadata.ingress_port : exact;
hdr.ethernet.srcAddr : exact;
hdr.ethernet.dstAddr : exact;
- hdr.ethernet.etherType : exact;
+ hdr.ethernet.etherType : optional;
}
actions = {
set_egress_port;
diff --git a/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation_p4info.txt b/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation_p4info.txt
index 241d989..b984b4c 100644
--- a/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation_p4info.txt
+++ b/protocols/p4runtime/ctl/src/test/resources/test_p4runtime_translation_p4info.txt
@@ -36,7 +36,7 @@
id: 4
name: "hdr.ethernet.etherType"
bitwidth: 16
- match_type: EXACT
+ match_type: OPTIONAL
}
action_refs {
id: 27607748
diff --git a/protocols/p4runtime/model/src/main/java/org/onosproject/p4runtime/model/P4InfoParser.java b/protocols/p4runtime/model/src/main/java/org/onosproject/p4runtime/model/P4InfoParser.java
index b01fb41..0bb0360 100644
--- a/protocols/p4runtime/model/src/main/java/org/onosproject/p4runtime/model/P4InfoParser.java
+++ b/protocols/p4runtime/model/src/main/java/org/onosproject/p4runtime/model/P4InfoParser.java
@@ -114,6 +114,7 @@
.put(MatchField.MatchType.LPM, PiMatchType.LPM)
.put(MatchField.MatchType.TERNARY, PiMatchType.TERNARY)
.put(MatchField.MatchType.RANGE, PiMatchType.RANGE)
+ .put(MatchField.MatchType.OPTIONAL, PiMatchType.OPTIONAL)
// Don't map UNSPECIFIED as we don't support it at the moment.
.build();
public static final int NO_SIZE = -1;
diff --git a/protocols/p4runtime/model/src/test/java/org/onosproject/p4runtime/model/P4InfoParserTest.java b/protocols/p4runtime/model/src/test/java/org/onosproject/p4runtime/model/P4InfoParserTest.java
index 0432a18..558acb1 100644
--- a/protocols/p4runtime/model/src/test/java/org/onosproject/p4runtime/model/P4InfoParserTest.java
+++ b/protocols/p4runtime/model/src/test/java/org/onosproject/p4runtime/model/P4InfoParserTest.java
@@ -281,11 +281,11 @@
}
/**
- * Tests parse method with P4Runtime translation fields.
+ * Tests parse method with P4Runtime translation fields and optional fields.
* @throws Exception if equality group objects dose not match as expected
*/
@Test
- public void testParseP4RuntimeTranslation() throws Exception {
+ public void testParseP4RuntimeTranslationAndOptional() throws Exception {
PiPipelineModel model = P4InfoParser.parse(p4InfoUrl2);
// Generate a P4Info object from the file
final P4Info p4info;
@@ -312,6 +312,7 @@
case LPM: piMatchType = PiMatchType.LPM; break;
case TERNARY: piMatchType = PiMatchType.TERNARY; break;
case RANGE: piMatchType = PiMatchType.RANGE; break;
+ case OPTIONAL: piMatchType = PiMatchType.OPTIONAL; break;
default: Assert.fail(); return;
}
if (matchFieldIter.getTypeName().getName().equals("mac_addr_t")) {
diff --git a/protocols/p4runtime/model/src/test/resources/org/onosproject/p4runtime/model/test_p4runtime_translation_p4info.txt b/protocols/p4runtime/model/src/test/resources/org/onosproject/p4runtime/model/test_p4runtime_translation_p4info.txt
index 241d989..b984b4c 100644
--- a/protocols/p4runtime/model/src/test/resources/org/onosproject/p4runtime/model/test_p4runtime_translation_p4info.txt
+++ b/protocols/p4runtime/model/src/test/resources/org/onosproject/p4runtime/model/test_p4runtime_translation_p4info.txt
@@ -36,7 +36,7 @@
id: 4
name: "hdr.ethernet.etherType"
bitwidth: 16
- match_type: EXACT
+ match_type: OPTIONAL
}
action_refs {
id: 27607748
diff --git a/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/FieldMatchCodec.java b/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/FieldMatchCodec.java
index 5e2ec43..d42e6b9 100644
--- a/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/FieldMatchCodec.java
+++ b/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/FieldMatchCodec.java
@@ -23,6 +23,7 @@
import org.onosproject.net.pi.runtime.PiExactFieldMatch;
import org.onosproject.net.pi.runtime.PiFieldMatch;
import org.onosproject.net.pi.runtime.PiLpmFieldMatch;
+import org.onosproject.net.pi.runtime.PiOptionalFieldMatch;
import org.onosproject.net.pi.runtime.PiRangeFieldMatch;
import org.onosproject.net.pi.runtime.PiTernaryFieldMatch;
import org.onosproject.p4runtime.ctl.utils.P4InfoBrowser;
@@ -33,6 +34,7 @@
import static org.onlab.util.ImmutableByteSequence.copyFrom;
import static org.onosproject.p4runtime.ctl.codec.Utils.assertPrefixLen;
import static org.onosproject.p4runtime.ctl.codec.Utils.assertSize;
+import static org.onosproject.p4runtime.ctl.codec.Utils.sdnStringUnsupported;
/**
* Codec for P4Runtime FieldMatch. Metadata is expected to be a Preamble for
@@ -64,6 +66,7 @@
matchFieldInfo.getName(), tablePreamble.getName());
int fieldId = matchFieldInfo.getId();
int fieldBitwidth = matchFieldInfo.getBitwidth();
+ boolean isSdnString = browser.isTypeString(matchFieldInfo.getTypeName());
messageBuilder.setFieldId(fieldId);
@@ -71,8 +74,7 @@
case EXACT:
PiExactFieldMatch fieldMatch = (PiExactFieldMatch) piFieldMatch;
ByteString exactValue = ByteString.copyFrom(fieldMatch.value().asReadOnlyBuffer());
- // We support string only for EXACT match (via p4runtime_translation)
- if (!browser.isTypeString(matchFieldInfo.getTypeName())) {
+ if (!isSdnString) {
assertSize(VALUE_OF_PREFIX + entityName, exactValue, fieldBitwidth);
}
return messageBuilder.setExact(
@@ -85,6 +87,9 @@
PiTernaryFieldMatch ternaryMatch = (PiTernaryFieldMatch) piFieldMatch;
ByteString ternaryValue = ByteString.copyFrom(ternaryMatch.value().asReadOnlyBuffer());
ByteString ternaryMask = ByteString.copyFrom(ternaryMatch.mask().asReadOnlyBuffer());
+ if (isSdnString) {
+ sdnStringUnsupported(entityName, piFieldMatch.type());
+ }
assertSize(VALUE_OF_PREFIX + entityName, ternaryValue, fieldBitwidth);
assertSize(MASK_OF_PREFIX + entityName, ternaryMask, fieldBitwidth);
return messageBuilder.setTernary(
@@ -98,6 +103,9 @@
PiLpmFieldMatch lpmMatch = (PiLpmFieldMatch) piFieldMatch;
ByteString lpmValue = ByteString.copyFrom(lpmMatch.value().asReadOnlyBuffer());
int lpmPrefixLen = lpmMatch.prefixLength();
+ if (isSdnString) {
+ sdnStringUnsupported(entityName, piFieldMatch.type());
+ }
assertSize(VALUE_OF_PREFIX + entityName, lpmValue, fieldBitwidth);
assertPrefixLen(entityName, lpmPrefixLen, fieldBitwidth);
return messageBuilder.setLpm(
@@ -110,6 +118,9 @@
PiRangeFieldMatch rangeMatch = (PiRangeFieldMatch) piFieldMatch;
ByteString rangeHighValue = ByteString.copyFrom(rangeMatch.highValue().asReadOnlyBuffer());
ByteString rangeLowValue = ByteString.copyFrom(rangeMatch.lowValue().asReadOnlyBuffer());
+ if (isSdnString) {
+ sdnStringUnsupported(entityName, piFieldMatch.type());
+ }
assertSize(HIGH_RANGE_VALUE_OF_PREFIX + entityName, rangeHighValue, fieldBitwidth);
assertSize(LOW_RANGE_VALUE_OF_PREFIX + entityName, rangeLowValue, fieldBitwidth);
return messageBuilder.setRange(
@@ -118,6 +129,17 @@
.setLow(rangeLowValue)
.build())
.build();
+ case OPTIONAL:
+ PiOptionalFieldMatch optionalMatch = (PiOptionalFieldMatch) piFieldMatch;
+ ByteString optionalValue = ByteString.copyFrom(optionalMatch.value().asReadOnlyBuffer());
+ if (!isSdnString) {
+ assertSize(VALUE_OF_PREFIX + entityName, optionalValue, fieldBitwidth);
+ }
+ return messageBuilder.setOptional(
+ P4RuntimeOuterClass.FieldMatch.Optional.newBuilder()
+ .setValue(optionalValue)
+ .build())
+ .build();
default:
throw new CodecException(format(
"Building of match type %s not implemented", piFieldMatch.type()));
@@ -156,6 +178,10 @@
ImmutableByteSequence rangeHighValue = copyFrom(rangeFieldMatch.getHigh().asReadOnlyByteBuffer());
ImmutableByteSequence rangeLowValue = copyFrom(rangeFieldMatch.getLow().asReadOnlyByteBuffer());
return new PiRangeFieldMatch(headerFieldId, rangeLowValue, rangeHighValue);
+ case OPTIONAL:
+ P4RuntimeOuterClass.FieldMatch.Optional optionalFieldMatch = message.getOptional();
+ ImmutableByteSequence optionalValue = copyFrom(optionalFieldMatch.getValue().asReadOnlyByteBuffer());
+ return new PiOptionalFieldMatch(headerFieldId, optionalValue);
default:
throw new CodecException(format(
"Decoding of field match type '%s' not implemented", typeCase.name()));
diff --git a/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/Utils.java b/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/Utils.java
index c72489a..2895b83 100644
--- a/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/Utils.java
+++ b/protocols/p4runtime/utils/src/main/java/org/onosproject/p4runtime/ctl/codec/Utils.java
@@ -17,6 +17,7 @@
package org.onosproject.p4runtime.ctl.codec;
import com.google.protobuf.ByteString;
+import org.onosproject.net.pi.model.PiMatchType;
import static java.lang.String.format;
@@ -49,4 +50,11 @@
entityDescr, bitWidth, prefixLength));
}
}
+
+ static void sdnStringUnsupported(String entityDescr, PiMatchType matchType)
+ throws CodecException {
+ throw new CodecException(format(
+ "%s is expected to be a sdn_string, but it is unsupported for %s match type",
+ entityDescr, matchType.name()));
+ }
}