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