Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.flow; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 18 | import com.google.common.base.MoreObjects; |
| 19 | import com.google.common.collect.ImmutableSet; |
| 20 | import org.onlab.packet.Ip6Address; |
| 21 | import org.onlab.packet.IpPrefix; |
| 22 | import org.onlab.packet.MacAddress; |
| 23 | import org.onlab.packet.MplsLabel; |
| 24 | import org.onlab.packet.VlanId; |
| 25 | import org.onosproject.net.PortNumber; |
| 26 | import org.onosproject.net.flow.criteria.Criteria; |
| 27 | import org.onosproject.net.flow.criteria.Criterion; |
| 28 | |
| 29 | import java.util.Collections; |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 30 | import java.util.HashMap; |
| 31 | import java.util.Map; |
| 32 | import java.util.Objects; |
| 33 | import java.util.Set; |
| 34 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Default traffic selector implementation. |
| 37 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 38 | public final class DefaultTrafficSelector implements TrafficSelector { |
| 39 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 40 | private final Set<Criterion> criteria; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 41 | |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 42 | private static final TrafficSelector EMPTY |
| 43 | = new DefaultTrafficSelector(Collections.emptySet()); |
| 44 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 45 | /** |
| 46 | * Creates a new traffic selector with the specified criteria. |
| 47 | * |
| 48 | * @param criteria criteria |
| 49 | */ |
| 50 | private DefaultTrafficSelector(Set<Criterion> criteria) { |
Yuta HIGUCHI | 2809bf3 | 2014-10-20 22:44:12 -0700 | [diff] [blame] | 51 | this.criteria = ImmutableSet.copyOf(criteria); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 52 | } |
| 53 | |
| 54 | @Override |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 55 | public Set<Criterion> criteria() { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 56 | return criteria; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 57 | } |
| 58 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 59 | @Override |
Jonathan Hart | 936c49d | 2014-10-23 16:38:59 -0700 | [diff] [blame] | 60 | public Criterion getCriterion(Criterion.Type type) { |
| 61 | for (Criterion c : criteria) { |
| 62 | if (c.type() == type) { |
| 63 | return c; |
| 64 | } |
| 65 | } |
| 66 | return null; |
| 67 | } |
| 68 | |
| 69 | @Override |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 70 | public int hashCode() { |
Thomas Vachuska | 9b2da21 | 2014-11-10 19:30:25 -0800 | [diff] [blame] | 71 | return criteria.hashCode(); |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 72 | } |
| 73 | |
| 74 | @Override |
| 75 | public boolean equals(Object obj) { |
| 76 | if (this == obj) { |
| 77 | return true; |
| 78 | } |
| 79 | if (obj instanceof DefaultTrafficSelector) { |
| 80 | DefaultTrafficSelector that = (DefaultTrafficSelector) obj; |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 81 | return Objects.equals(criteria, that.criteria); |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 82 | |
| 83 | } |
| 84 | return false; |
| 85 | } |
| 86 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 87 | @Override |
| 88 | public String toString() { |
| 89 | return MoreObjects.toStringHelper(getClass()) |
| 90 | .add("criteria", criteria) |
| 91 | .toString(); |
| 92 | } |
| 93 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 94 | /** |
| 95 | * Returns a new traffic selector builder. |
| 96 | * |
| 97 | * @return traffic selector builder |
| 98 | */ |
| 99 | public static TrafficSelector.Builder builder() { |
| 100 | return new Builder(); |
| 101 | } |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 102 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 103 | /** |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 104 | * Returns an empty traffic selector. |
| 105 | * |
| 106 | * @return empty traffic selector |
| 107 | */ |
| 108 | public static TrafficSelector emptySelector() { |
| 109 | return EMPTY; |
| 110 | } |
| 111 | |
| 112 | /** |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 113 | * Returns a new traffic selector builder primed to produce entities |
| 114 | * patterned after the supplied selector. |
| 115 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 116 | * @param selector base selector |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 117 | * @return traffic selector builder |
| 118 | */ |
| 119 | public static TrafficSelector.Builder builder(TrafficSelector selector) { |
| 120 | return new Builder(selector); |
| 121 | } |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 122 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 123 | /** |
| 124 | * Builder of traffic selector entities. |
| 125 | */ |
| 126 | public static final class Builder implements TrafficSelector.Builder { |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 127 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 128 | private final Map<Criterion.Type, Criterion> selector = new HashMap<>(); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 129 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 130 | private Builder() { |
| 131 | } |
| 132 | |
| 133 | private Builder(TrafficSelector selector) { |
| 134 | for (Criterion c : selector.criteria()) { |
| 135 | add(c); |
| 136 | } |
| 137 | } |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 138 | |
| 139 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 140 | public Builder add(Criterion criterion) { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 141 | selector.put(criterion.type(), criterion); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 142 | return this; |
| 143 | } |
| 144 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 145 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 146 | public Builder matchInPort(PortNumber port) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 147 | return add(Criteria.matchInPort(port)); |
| 148 | } |
| 149 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 150 | @Override |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 151 | public Builder matchInPhyPort(PortNumber port) { |
| 152 | return add(Criteria.matchInPhyPort(port)); |
| 153 | } |
| 154 | |
| 155 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 156 | public Builder matchMetadata(long metadata) { |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 157 | return add(Criteria.matchMetadata(metadata)); |
| 158 | } |
| 159 | |
| 160 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 161 | public Builder matchEthDst(MacAddress addr) { |
| 162 | return add(Criteria.matchEthDst(addr)); |
| 163 | } |
| 164 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 165 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 166 | public Builder matchEthSrc(MacAddress addr) { |
| 167 | return add(Criteria.matchEthSrc(addr)); |
| 168 | } |
| 169 | |
| 170 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 171 | public Builder matchEthType(short ethType) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 172 | return add(Criteria.matchEthType(ethType)); |
| 173 | } |
| 174 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 175 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 176 | public Builder matchVlanId(VlanId vlanId) { |
| 177 | return add(Criteria.matchVlanId(vlanId)); |
| 178 | } |
| 179 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 180 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 181 | public Builder matchVlanPcp(byte vlanPcp) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 182 | return add(Criteria.matchVlanPcp(vlanPcp)); |
| 183 | } |
| 184 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 185 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 186 | public Builder matchIPDscp(byte ipDscp) { |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 187 | return add(Criteria.matchIPDscp(ipDscp)); |
| 188 | } |
| 189 | |
| 190 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 191 | public Builder matchIPEcn(byte ipEcn) { |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 192 | return add(Criteria.matchIPEcn(ipEcn)); |
| 193 | } |
| 194 | |
| 195 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 196 | public Builder matchIPProtocol(byte proto) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 197 | return add(Criteria.matchIPProtocol(proto)); |
| 198 | } |
| 199 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 200 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 201 | public Builder matchIPSrc(IpPrefix ip) { |
| 202 | return add(Criteria.matchIPSrc(ip)); |
| 203 | } |
| 204 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 205 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 206 | public Builder matchIPDst(IpPrefix ip) { |
| 207 | return add(Criteria.matchIPDst(ip)); |
| 208 | } |
| 209 | |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 210 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 211 | public Builder matchTcpSrc(short tcpPort) { |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 212 | return add(Criteria.matchTcpSrc(tcpPort)); |
| 213 | } |
| 214 | |
| 215 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 216 | public Builder matchTcpDst(short tcpPort) { |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 217 | return add(Criteria.matchTcpDst(tcpPort)); |
| 218 | } |
| 219 | |
| 220 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 221 | public Builder matchUdpSrc(short udpPort) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 222 | return add(Criteria.matchUdpSrc(udpPort)); |
| 223 | } |
| 224 | |
| 225 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 226 | public Builder matchUdpDst(short udpPort) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 227 | return add(Criteria.matchUdpDst(udpPort)); |
| 228 | } |
| 229 | |
| 230 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 231 | public Builder matchSctpSrc(short sctpPort) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 232 | return add(Criteria.matchSctpSrc(sctpPort)); |
| 233 | } |
| 234 | |
| 235 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 236 | public Builder matchSctpDst(short sctpPort) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 237 | return add(Criteria.matchSctpDst(sctpPort)); |
| 238 | } |
| 239 | |
| 240 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 241 | public Builder matchIcmpType(byte icmpType) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 242 | return add(Criteria.matchIcmpType(icmpType)); |
| 243 | } |
| 244 | |
| 245 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 246 | public Builder matchIcmpCode(byte icmpCode) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 247 | return add(Criteria.matchIcmpCode(icmpCode)); |
| 248 | } |
| 249 | |
| 250 | @Override |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 251 | public Builder matchIPv6Src(IpPrefix ip) { |
| 252 | return add(Criteria.matchIPv6Src(ip)); |
| 253 | } |
| 254 | |
| 255 | @Override |
| 256 | public Builder matchIPv6Dst(IpPrefix ip) { |
| 257 | return add(Criteria.matchIPv6Dst(ip)); |
| 258 | } |
| 259 | |
| 260 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 261 | public Builder matchIPv6FlowLabel(int flowLabel) { |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 262 | return add(Criteria.matchIPv6FlowLabel(flowLabel)); |
| 263 | } |
| 264 | |
| 265 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 266 | public Builder matchIcmpv6Type(byte icmpv6Type) { |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 267 | return add(Criteria.matchIcmpv6Type(icmpv6Type)); |
| 268 | } |
| 269 | |
| 270 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 271 | public Builder matchIcmpv6Code(byte icmpv6Code) { |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 272 | return add(Criteria.matchIcmpv6Code(icmpv6Code)); |
| 273 | } |
| 274 | |
| 275 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 276 | public Builder matchIPv6NDTargetAddress(Ip6Address targetAddress) { |
| 277 | return add(Criteria.matchIPv6NDTargetAddress(targetAddress)); |
| 278 | } |
| 279 | |
| 280 | @Override |
| 281 | public Builder matchIPv6NDSourceLinkLayerAddress(MacAddress mac) { |
| 282 | return add(Criteria.matchIPv6NDSourceLinkLayerAddress(mac)); |
| 283 | } |
| 284 | |
| 285 | @Override |
| 286 | public Builder matchIPv6NDTargetLinkLayerAddress(MacAddress mac) { |
| 287 | return add(Criteria.matchIPv6NDTargetLinkLayerAddress(mac)); |
| 288 | } |
| 289 | |
| 290 | @Override |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 291 | public Builder matchMplsLabel(MplsLabel mplsLabel) { |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 292 | return add(Criteria.matchMplsLabel(mplsLabel)); |
| 293 | } |
| 294 | |
| 295 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 296 | public Builder matchIPv6ExthdrFlags(int exthdrFlags) { |
Pavlin Radoslavov | 5e4f754 | 2015-02-06 18:18:21 -0800 | [diff] [blame] | 297 | return add(Criteria.matchIPv6ExthdrFlags(exthdrFlags)); |
| 298 | } |
| 299 | |
| 300 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 301 | public Builder matchLambda(short lambda) { |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 302 | return add(Criteria.matchLambda(lambda)); |
| 303 | } |
| 304 | |
| 305 | @Override |
Sho SHIMIZU | d796ae4 | 2015-02-26 12:08:01 -0800 | [diff] [blame] | 306 | public Builder matchOpticalSignalType(short signalType) { |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 307 | return add(Criteria.matchOpticalSignalType(signalType)); |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 308 | } |
| 309 | |
| 310 | @Override |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 311 | public TrafficSelector build() { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 312 | return new DefaultTrafficSelector(ImmutableSet.copyOf(selector.values())); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 313 | } |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 314 | } |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 315 | } |