mirrors/onos
1
0
Fork 0
mirror of https://github.com/opennetworkinglab/onos.git synced 2025-10-17 10:21:52 +02:00
Code Issues Projects Releases Wiki Activity

Added method to retrieve field matches by ID in PiCriterion

Browse Source 
Change-Id: Ice2abc7a3b60bd4e977fdfe977fe624852e54d05
This commit is contained in:
Carmelo Cascone 2017-07-18 10:51:07 -04:00
parent 432f718de7
commit 32a01b2971
1 changed files with 75 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
core/api/src/main/java/org/onosproject/net/flow/criteria/PiCriterion.java
View File

@ -18,19 +18,17 @@ package org.onosproject.net.flow.criteria;
import com.google.common.annotations.Beta; import com.google.common.annotations.Beta;
import com.google.common.base.Objects; import com.google.common.base.Objects;
import com.google.common.collect.ImmutableSet; import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps; import org.onosproject.net.pi.runtime.PiExactFieldMatch;
import org.onosproject.net.pi.runtime.PiFieldMatch; import org.onosproject.net.pi.runtime.PiFieldMatch;
import org.onosproject.net.pi.runtime.PiHeaderFieldId; import org.onosproject.net.pi.runtime.PiHeaderFieldId;
import org.onosproject.net.pi.runtime.PiExactFieldMatch;
import org.onosproject.net.pi.runtime.PiTernaryFieldMatch;
import org.onosproject.net.pi.runtime.PiLpmFieldMatch; import org.onosproject.net.pi.runtime.PiLpmFieldMatch;
import org.onosproject.net.pi.runtime.PiRangeFieldMatch; import org.onosproject.net.pi.runtime.PiRangeFieldMatch;
import org.onosproject.net.pi.runtime.PiTernaryFieldMatch;
import org.onosproject.net.pi.runtime.PiValidFieldMatch; import org.onosproject.net.pi.runtime.PiValidFieldMatch;
import java.util.Collection; import java.util.Collection;
import java.util.Map; import java.util.Optional;
import java.util.Set;
import java.util.StringJoiner; import java.util.StringJoiner;
import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkArgument;
@ -42,24 +40,34 @@ import static org.onlab.util.ImmutableByteSequence.copyFrom;
@Beta @Beta
public final class PiCriterion implements Criterion { public final class PiCriterion implements Criterion {
private final Set<PiFieldMatch> fieldMatches; private final ImmutableMap<PiHeaderFieldId, PiFieldMatch> fieldMatchMap;
/** /**
* Creates a new protocol-independent criterion for the given match fields. * Creates a new protocol-independent criterion for the given match fields.
* *
* @param fieldMatches fields to match * @param fieldMatchMap field match map
*/ */
private PiCriterion(Set<PiFieldMatch> fieldMatches) { private PiCriterion(ImmutableMap<PiHeaderFieldId, PiFieldMatch> fieldMatchMap) {
this.fieldMatches = fieldMatches; this.fieldMatchMap = fieldMatchMap;
} }
/** /**
* Returns the match parameters map of this selector. * Returns all protocol-independent field matches defined by this criterion.
* *
* @return a match parameter map * @return collection of match parameters
*/ */
public Collection<PiFieldMatch> fieldMatches() { public Collection<PiFieldMatch> fieldMatches() {
return fieldMatches; return fieldMatchMap.values();
}
/**
* If present, returns the field match associated with the given header field identifier.
*
* @param fieldId field identifier
* @return optional field match
*/
public Optional<PiFieldMatch> fieldMatch(PiHeaderFieldId fieldId) {
return Optional.ofNullable(fieldMatchMap.get(fieldId));
} }
@Override @Override
@ -76,18 +84,18 @@ public final class PiCriterion implements Criterion {
return false; return false;
} }
PiCriterion that = (PiCriterion) o; PiCriterion that = (PiCriterion) o;
return Objects.equal(fieldMatches, that.fieldMatches); return Objects.equal(fieldMatchMap, that.fieldMatchMap);
} }
@Override @Override
public int hashCode() { public int hashCode() {
return Objects.hashCode(fieldMatches); return Objects.hashCode(fieldMatchMap);
} }
@Override @Override
public String toString() { public String toString() {
StringJoiner stringParams = new StringJoiner(", ", "{", "}"); StringJoiner stringParams = new StringJoiner(", ", "{", "}");
fieldMatches.forEach(f -> stringParams.add(f.toString())); fieldMatchMap.forEach((key, value) -> stringParams.add(value.toString()));
return stringParams.toString(); return stringParams.toString();
} }
@ -107,7 +115,7 @@ public final class PiCriterion implements Criterion {
public static final class Builder { public static final class Builder {
// Use map to guarantee that there's only one field match per field id. // Use map to guarantee that there's only one field match per field id.
private final Map<PiHeaderFieldId, PiFieldMatch> piFieldMatches = Maps.newHashMap(); private final ImmutableMap.Builder<PiHeaderFieldId, PiFieldMatch> fieldMatchMapBuilder = ImmutableMap.builder();
private Builder() { private Builder() {
// ban constructor. // ban constructor.
@ -117,11 +125,11 @@ public final class PiCriterion implements Criterion {
* Adds an exact field match for the given fieldId and value. * Adds an exact field match for the given fieldId and value.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value exact match value * @param value exact match value
* @return this * @return this
*/ */
public Builder matchExact(PiHeaderFieldId fieldId, short value) { public Builder matchExact(PiHeaderFieldId fieldId, short value) {
piFieldMatches.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value))); fieldMatchMapBuilder.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value)));
return this; return this;
} }
@ -129,11 +137,11 @@ public final class PiCriterion implements Criterion {
* Adds an exact field match for the given fieldId and value. * Adds an exact field match for the given fieldId and value.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value exact match value * @param value exact match value
* @return this * @return this
*/ */
public Builder matchExact(PiHeaderFieldId fieldId, int value) { public Builder matchExact(PiHeaderFieldId fieldId, int value) {
piFieldMatches.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value))); fieldMatchMapBuilder.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value)));
return this; return this;
} }
@ -141,11 +149,11 @@ public final class PiCriterion implements Criterion {
* Adds an exact field match for the given fieldId and value. * Adds an exact field match for the given fieldId and value.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value exact match value * @param value exact match value
* @return this * @return this
*/ */
public Builder matchExact(PiHeaderFieldId fieldId, long value) { public Builder matchExact(PiHeaderFieldId fieldId, long value) {
piFieldMatches.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value))); fieldMatchMapBuilder.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value)));
return this; return this;
} }
@ -153,11 +161,11 @@ public final class PiCriterion implements Criterion {
* Adds an exact field match for the given fieldId and value. * Adds an exact field match for the given fieldId and value.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value exact match value * @param value exact match value
* @return this * @return this
*/ */
public Builder matchExact(PiHeaderFieldId fieldId, byte[] value) { public Builder matchExact(PiHeaderFieldId fieldId, byte[] value) {
piFieldMatches.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value))); fieldMatchMapBuilder.put(fieldId, new PiExactFieldMatch(fieldId, copyFrom(value)));
return this; return this;
} }
@ -165,12 +173,12 @@ public final class PiCriterion implements Criterion {
* Adds a ternary field match for the given fieldId, value and mask. * Adds a ternary field match for the given fieldId, value and mask.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value ternary match value * @param value ternary match value
* @param mask ternary match mask * @param mask ternary match mask
* @return this * @return this
*/ */
public Builder matchTernary(PiHeaderFieldId fieldId, short value, short mask) { public Builder matchTernary(PiHeaderFieldId fieldId, short value, short mask) {
piFieldMatches.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask))); fieldMatchMapBuilder.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask)));
return this; return this;
} }
@ -178,12 +186,12 @@ public final class PiCriterion implements Criterion {
* Adds a ternary field match for the given fieldId, value and mask. * Adds a ternary field match for the given fieldId, value and mask.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value ternary match value * @param value ternary match value
* @param mask ternary match mask * @param mask ternary match mask
* @return this * @return this
*/ */
public Builder matchTernary(PiHeaderFieldId fieldId, int value, int mask) { public Builder matchTernary(PiHeaderFieldId fieldId, int value, int mask) {
piFieldMatches.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask))); fieldMatchMapBuilder.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask)));
return this; return this;
} }
@ -191,12 +199,12 @@ public final class PiCriterion implements Criterion {
* Adds a ternary field match for the given fieldId, value and mask. * Adds a ternary field match for the given fieldId, value and mask.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value ternary match value * @param value ternary match value
* @param mask ternary match mask * @param mask ternary match mask
* @return this * @return this
*/ */
public Builder matchTernary(PiHeaderFieldId fieldId, long value, long mask) { public Builder matchTernary(PiHeaderFieldId fieldId, long value, long mask) {
piFieldMatches.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask))); fieldMatchMapBuilder.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask)));
return this; return this;
} }
@ -204,64 +212,64 @@ public final class PiCriterion implements Criterion {
* Adds a ternary field match for the given fieldId, value and mask. * Adds a ternary field match for the given fieldId, value and mask.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value ternary match value * @param value ternary match value
* @param mask ternary match mask * @param mask ternary match mask
* @return this * @return this
*/ */
public Builder matchTernary(PiHeaderFieldId fieldId, byte[] value, byte[] mask) { public Builder matchTernary(PiHeaderFieldId fieldId, byte[] value, byte[] mask) {
piFieldMatches.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask))); fieldMatchMapBuilder.put(fieldId, new PiTernaryFieldMatch(fieldId, copyFrom(value), copyFrom(mask)));
return this; return this;
} }
/** /**
* Adds a longest-prefix field match for the given fieldId, value and prefix length. * Adds a longest-prefix field match for the given fieldId, value and prefix length.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value lpm match value * @param value lpm match value
* @param prefixLength lpm match prefix length * @param prefixLength lpm match prefix length
* @return this * @return this
*/ */
public Builder matchLpm(PiHeaderFieldId fieldId, short value, int prefixLength) { public Builder matchLpm(PiHeaderFieldId fieldId, short value, int prefixLength) {
piFieldMatches.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength)); fieldMatchMapBuilder.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength));
return this; return this;
} }
/** /**
* Adds a longest-prefix field match for the given fieldId, value and prefix length. * Adds a longest-prefix field match for the given fieldId, value and prefix length.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value lpm match value * @param value lpm match value
* @param prefixLength lpm match prefix length * @param prefixLength lpm match prefix length
* @return this * @return this
*/ */
public Builder matchLpm(PiHeaderFieldId fieldId, int value, int prefixLength) { public Builder matchLpm(PiHeaderFieldId fieldId, int value, int prefixLength) {
piFieldMatches.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength)); fieldMatchMapBuilder.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength));
return this; return this;
} }
/** /**
* Adds a longest-prefix field match for the given fieldId, value and prefix length. * Adds a longest-prefix field match for the given fieldId, value and prefix length.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value lpm match value * @param value lpm match value
* @param prefixLength lpm match prefix length * @param prefixLength lpm match prefix length
* @return this * @return this
*/ */
public Builder matchLpm(PiHeaderFieldId fieldId, long value, int prefixLength) { public Builder matchLpm(PiHeaderFieldId fieldId, long value, int prefixLength) {
piFieldMatches.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength)); fieldMatchMapBuilder.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength));
return this; return this;
} }
/** /**
* Adds a longest-prefix field match for the given fieldId, value and prefix length. * Adds a longest-prefix field match for the given fieldId, value and prefix length.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param value lpm match value * @param value lpm match value
* @param prefixLength lpm match prefix length * @param prefixLength lpm match prefix length
* @return this * @return this
*/ */
public Builder matchLpm(PiHeaderFieldId fieldId, byte[] value, int prefixLength) { public Builder matchLpm(PiHeaderFieldId fieldId, byte[] value, int prefixLength) {
piFieldMatches.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength)); fieldMatchMapBuilder.put(fieldId, new PiLpmFieldMatch(fieldId, copyFrom(value), prefixLength));
return this; return this;
} }
@ -273,7 +281,7 @@ public final class PiCriterion implements Criterion {
* @return this * @return this
*/ */
public Builder matchValid(PiHeaderFieldId fieldId, boolean flag) { public Builder matchValid(PiHeaderFieldId fieldId, boolean flag) {
piFieldMatches.put(fieldId, new PiValidFieldMatch(fieldId, flag)); fieldMatchMapBuilder.put(fieldId, new PiValidFieldMatch(fieldId, flag));
return this; return this;
} }
@ -281,12 +289,12 @@ public final class PiCriterion implements Criterion {
* Adds a range field match for the given fieldId, low and high. * Adds a range field match for the given fieldId, low and high.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param low range match low value * @param low range match low value
* @param high range match high value * @param high range match high value
* @return this * @return this
*/ */
public Builder matchRange(PiHeaderFieldId fieldId, short low, short high) { public Builder matchRange(PiHeaderFieldId fieldId, short low, short high) {
piFieldMatches.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high))); fieldMatchMapBuilder.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high)));
return this; return this;
} }
@ -294,36 +302,38 @@ public final class PiCriterion implements Criterion {
* Adds a range field match for the given fieldId, low and high. * Adds a range field match for the given fieldId, low and high.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param low range match low value * @param low range match low value
* @param high range match high value * @param high range match high value
* @return this * @return this
*/ */
public Builder matchRange(PiHeaderFieldId fieldId, int low, int high) { public Builder matchRange(PiHeaderFieldId fieldId, int low, int high) {
piFieldMatches.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high))); fieldMatchMapBuilder.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high)));
return this; return this;
} }
/** /**
* Adds a range field match for the given fieldId, low and high. * Adds a range field match for the given fieldId, low and high.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param low range match low value * @param low range match low value
* @param high range match high value * @param high range match high value
* @return this * @return this
*/ */
public Builder matchRange(PiHeaderFieldId fieldId, long low, long high) { public Builder matchRange(PiHeaderFieldId fieldId, long low, long high) {
piFieldMatches.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high))); fieldMatchMapBuilder.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high)));
return this; return this;
} }
/** /**
* Adds a range field match for the given fieldId, low and high. * Adds a range field match for the given fieldId, low and high.
* *
* @param fieldId protocol-independent header field Id * @param fieldId protocol-independent header field Id
* @param low range match low value * @param low range match low value
* @param high range match high value * @param high range match high value
* @return this * @return this
*/ */
public Builder matchRange(PiHeaderFieldId fieldId, byte[] low, byte[] high) { public Builder matchRange(PiHeaderFieldId fieldId, byte[] low, byte[] high) {
piFieldMatches.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high))); fieldMatchMapBuilder.put(fieldId, new PiRangeFieldMatch(fieldId, copyFrom(low), copyFrom(high)));
return this; return this;
} }
@ -333,8 +343,9 @@ public final class PiCriterion implements Criterion {
* @return PiCriterion * @return PiCriterion
*/ */
public Criterion build() { public Criterion build() {
checkArgument(piFieldMatches.size() > 0); ImmutableMap<PiHeaderFieldId, PiFieldMatch> fieldMatchMap = fieldMatchMapBuilder.build();
return new PiCriterion(ImmutableSet.copyOf(piFieldMatches.values())); checkArgument(fieldMatchMap.size() > 0, "Cannot build PI criterion with 0 field matches");
return new PiCriterion(fieldMatchMap);
} }
} }
} }