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 | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 17 | |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 18 | import com.google.common.base.MoreObjects; |
| 19 | import com.google.common.collect.ImmutableList; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 20 | import com.google.common.collect.Lists; |
Jonathan Hart | 8ef6d3b | 2015-03-08 21:21:27 -0700 | [diff] [blame] | 21 | import org.apache.commons.collections.ListUtils; |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 22 | import org.onlab.packet.IpAddress; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 23 | import org.onlab.packet.MacAddress; |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 24 | import org.onlab.packet.MplsLabel; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 25 | import org.onlab.packet.VlanId; |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 26 | import org.onosproject.core.GroupId; |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 27 | import org.onosproject.net.PortNumber; |
| 28 | import org.onosproject.net.flow.instructions.Instruction; |
| 29 | import org.onosproject.net.flow.instructions.Instructions; |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 30 | |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 31 | import java.util.Collections; |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 32 | import java.util.List; |
| 33 | import java.util.Objects; |
Yuta HIGUCHI | 2809bf3 | 2014-10-20 22:44:12 -0700 | [diff] [blame] | 34 | |
Ray Milkey | 4250735 | 2015-03-20 15:16:10 -0700 | [diff] [blame] | 35 | import static com.google.common.base.Preconditions.checkNotNull; |
| 36 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 37 | /** |
| 38 | * Default traffic treatment implementation. |
| 39 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 40 | public final class DefaultTrafficTreatment implements TrafficTreatment { |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 41 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 42 | private final List<Instruction> immediate; |
| 43 | private final List<Instruction> deferred; |
| 44 | private final Instructions.TableTypeTransition table; |
| 45 | |
| 46 | private final boolean hasClear; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 47 | |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 48 | private static final DefaultTrafficTreatment EMPTY |
| 49 | = new DefaultTrafficTreatment(Collections.emptyList()); |
| 50 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 51 | /** |
| 52 | * Creates a new traffic treatment from the specified list of instructions. |
| 53 | * |
| 54 | * @param instructions treatment instructions |
| 55 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 56 | private DefaultTrafficTreatment(List<Instruction> instructions) { |
Ray Milkey | 4250735 | 2015-03-20 15:16:10 -0700 | [diff] [blame] | 57 | this.immediate = ImmutableList.copyOf(checkNotNull(instructions)); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 58 | this.deferred = ImmutableList.of(); |
| 59 | this.hasClear = false; |
| 60 | this.table = null; |
| 61 | } |
| 62 | |
| 63 | private DefaultTrafficTreatment(List<Instruction> deferred, |
| 64 | List<Instruction> immediate, |
| 65 | Instructions.TableTypeTransition table, |
| 66 | boolean clear) { |
Ray Milkey | 4250735 | 2015-03-20 15:16:10 -0700 | [diff] [blame] | 67 | this.immediate = ImmutableList.copyOf(checkNotNull(immediate)); |
| 68 | this.deferred = ImmutableList.copyOf(checkNotNull(deferred)); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 69 | this.table = table; |
| 70 | this.hasClear = clear; |
| 71 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 72 | } |
| 73 | |
| 74 | @Override |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 75 | public List<Instruction> deferred() { |
| 76 | return deferred; |
| 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public List<Instruction> immediate() { |
| 81 | return immediate; |
| 82 | } |
| 83 | |
| 84 | @Override |
Jonathan Hart | 8ef6d3b | 2015-03-08 21:21:27 -0700 | [diff] [blame] | 85 | public List<Instruction> allInstructions() { |
| 86 | return ListUtils.union(immediate, deferred); |
| 87 | } |
| 88 | |
| 89 | @Override |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 90 | public Instructions.TableTypeTransition tableTransition() { |
| 91 | return table; |
| 92 | } |
| 93 | |
| 94 | @Override |
| 95 | public Boolean clearedDeferred() { |
| 96 | return hasClear; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 97 | } |
| 98 | |
| 99 | /** |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 100 | * Returns a new traffic treatment builder. |
| 101 | * |
| 102 | * @return traffic treatment builder |
| 103 | */ |
| 104 | public static TrafficTreatment.Builder builder() { |
| 105 | return new Builder(); |
| 106 | } |
| 107 | |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 108 | /** |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 109 | * Returns an empty traffic treatment. |
| 110 | * |
| 111 | * @return empty traffic treatment |
| 112 | */ |
| 113 | public static TrafficTreatment emptyTreatment() { |
| 114 | return EMPTY; |
| 115 | } |
| 116 | |
| 117 | /** |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 118 | * Returns a new traffic treatment builder primed to produce entities |
| 119 | * patterned after the supplied treatment. |
| 120 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 121 | * @param treatment base treatment |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 122 | * @return traffic treatment builder |
| 123 | */ |
| 124 | public static TrafficTreatment.Builder builder(TrafficTreatment treatment) { |
| 125 | return new Builder(treatment); |
| 126 | } |
| 127 | |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 128 | //FIXME: Order of instructions may affect hashcode |
| 129 | @Override |
| 130 | public int hashCode() { |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 131 | return Objects.hash(immediate, deferred, table); |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | @Override |
| 135 | public boolean equals(Object obj) { |
| 136 | if (this == obj) { |
| 137 | return true; |
| 138 | } |
| 139 | if (obj instanceof DefaultTrafficTreatment) { |
| 140 | DefaultTrafficTreatment that = (DefaultTrafficTreatment) obj; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 141 | return Objects.equals(immediate, that.immediate) && |
| 142 | Objects.equals(deferred, that.deferred) && |
| 143 | Objects.equals(table, that.table); |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 144 | |
| 145 | } |
| 146 | return false; |
| 147 | } |
| 148 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 149 | @Override |
| 150 | public String toString() { |
| 151 | return MoreObjects.toStringHelper(getClass()) |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 152 | .add("immediate", immediate) |
| 153 | .add("deferred", deferred) |
| 154 | .add("transition", table == null ? "None" : table.toString()) |
| 155 | .add("cleared", hasClear) |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 156 | .toString(); |
| 157 | } |
| 158 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 159 | /** |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 160 | * Builds a list of treatments following the following order. |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 161 | * Modifications -> Group -> Output (including drop) |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 162 | */ |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 163 | public static final class Builder implements TrafficTreatment.Builder { |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 164 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 165 | boolean drop = false; |
| 166 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 167 | boolean clear = false; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 168 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 169 | Instructions.TableTypeTransition table; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 170 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 171 | List<Instruction> deferred = Lists.newLinkedList(); |
| 172 | |
| 173 | List<Instruction> immediate = Lists.newLinkedList(); |
| 174 | |
| 175 | List<Instruction> current = immediate; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 176 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 177 | // Creates a new builder |
| 178 | private Builder() { |
| 179 | } |
| 180 | |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 181 | // Creates a new builder based off an existing treatment |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 182 | //FIXME only works for immediate instruction sets. |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 183 | private Builder(TrafficTreatment treatment) { |
Ray Milkey | 4250735 | 2015-03-20 15:16:10 -0700 | [diff] [blame] | 184 | for (Instruction instruction : treatment.immediate()) { |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 185 | add(instruction); |
| 186 | } |
| 187 | } |
| 188 | |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 189 | @Override |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 190 | public Builder add(Instruction instruction) { |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 191 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 192 | switch (instruction.type()) { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 193 | case DROP: |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 194 | case OUTPUT: |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 195 | case GROUP: |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 196 | case L0MODIFICATION: |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 197 | case L2MODIFICATION: |
| 198 | case L3MODIFICATION: |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 199 | current.add(instruction); |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 200 | break; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 201 | case TABLE: |
| 202 | table = (Instructions.TableTypeTransition) instruction; |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 203 | break; |
| 204 | default: |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 205 | throw new IllegalArgumentException("Unknown instruction type: " + |
| 206 | instruction.type()); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 207 | } |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 208 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 209 | return this; |
| 210 | } |
| 211 | |
| 212 | @Override |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 213 | public Builder drop() { |
| 214 | return add(Instructions.createDrop()); |
| 215 | } |
| 216 | |
| 217 | @Override |
| 218 | public Builder punt() { |
| 219 | return add(Instructions.createOutput(PortNumber.CONTROLLER)); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | @Override |
| 223 | public Builder setOutput(PortNumber number) { |
| 224 | return add(Instructions.createOutput(number)); |
| 225 | } |
| 226 | |
| 227 | @Override |
| 228 | public Builder setEthSrc(MacAddress addr) { |
| 229 | return add(Instructions.modL2Src(addr)); |
| 230 | } |
| 231 | |
| 232 | @Override |
| 233 | public Builder setEthDst(MacAddress addr) { |
| 234 | return add(Instructions.modL2Dst(addr)); |
| 235 | } |
| 236 | |
| 237 | @Override |
| 238 | public Builder setVlanId(VlanId id) { |
| 239 | return add(Instructions.modVlanId(id)); |
| 240 | } |
| 241 | |
| 242 | @Override |
| 243 | public Builder setVlanPcp(Byte pcp) { |
| 244 | return add(Instructions.modVlanPcp(pcp)); |
| 245 | } |
| 246 | |
| 247 | @Override |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 248 | public Builder setIpSrc(IpAddress addr) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 249 | return add(Instructions.modL3Src(addr)); |
| 250 | } |
| 251 | |
| 252 | @Override |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 253 | public Builder setIpDst(IpAddress addr) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 254 | return add(Instructions.modL3Dst(addr)); |
| 255 | } |
| 256 | |
| 257 | @Override |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 258 | public Builder decNwTtl() { |
| 259 | return add(Instructions.decNwTtl()); |
| 260 | } |
| 261 | |
| 262 | @Override |
| 263 | public Builder copyTtlIn() { |
| 264 | return add(Instructions.copyTtlIn()); |
| 265 | } |
| 266 | |
| 267 | @Override |
| 268 | public Builder copyTtlOut() { |
| 269 | return add(Instructions.copyTtlOut()); |
| 270 | } |
| 271 | |
| 272 | @Override |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 273 | public Builder pushMpls() { |
| 274 | return add(Instructions.pushMpls()); |
| 275 | } |
| 276 | |
| 277 | @Override |
| 278 | public Builder popMpls() { |
| 279 | return add(Instructions.popMpls()); |
| 280 | } |
| 281 | |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 282 | @Override |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 283 | public Builder popMpls(Short etherType) { |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 284 | return add(Instructions.popMpls(etherType)); |
| 285 | } |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 286 | |
| 287 | @Override |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 288 | public Builder setMpls(MplsLabel mplsLabel) { |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 289 | return add(Instructions.modMplsLabel(mplsLabel)); |
| 290 | } |
| 291 | |
| 292 | @Override |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 293 | public Builder decMplsTtl() { |
| 294 | return add(Instructions.decMplsTtl()); |
| 295 | } |
| 296 | |
| 297 | @Override |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 298 | public Builder setLambda(short lambda) { |
| 299 | return add(Instructions.modL0Lambda(lambda)); |
| 300 | } |
| 301 | |
| 302 | @Override |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 303 | public Builder group(GroupId groupId) { |
| 304 | return add(Instructions.createGroup(groupId)); |
| 305 | } |
| 306 | |
| 307 | @Override |
Saurav Das | fbe25c5 | 2015-03-04 11:12:00 -0800 | [diff] [blame] | 308 | public Builder popVlan() { |
| 309 | return add(Instructions.popVlan()); |
| 310 | } |
| 311 | |
| 312 | @Override |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 313 | public Builder pushVlan() { |
| 314 | return add(Instructions.pushVlan()); |
| 315 | } |
| 316 | |
| 317 | @Override |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 318 | public Builder transition(FlowRule.Type type) { |
| 319 | return add(Instructions.transition(type)); |
| 320 | } |
| 321 | |
| 322 | @Override |
| 323 | public Builder immediate() { |
| 324 | current = immediate; |
| 325 | return this; |
| 326 | } |
| 327 | |
| 328 | @Override |
| 329 | public Builder deferred() { |
| 330 | current = deferred; |
| 331 | return this; |
| 332 | } |
| 333 | |
| 334 | @Override |
| 335 | public Builder wipeDeferred() { |
| 336 | clear = true; |
| 337 | return this; |
| 338 | } |
| 339 | |
| 340 | @Override |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 341 | public TrafficTreatment build() { |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 342 | if (deferred.size() == 0 && immediate.size() == 0 |
| 343 | && table == null && !clear) { |
| 344 | drop(); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 345 | } |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 346 | return new DefaultTrafficTreatment(deferred, immediate, table, clear); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 347 | } |
| 348 | |
| 349 | } |
| 350 | |
| 351 | } |