Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present 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 | |
Yuta HIGUCHI | 6ee6b8c | 2017-05-09 14:44:30 -0700 | [diff] [blame] | 18 | import java.util.ArrayList; |
Yafit Hadar | 5796d97 | 2015-10-15 13:16:11 +0300 | [diff] [blame] | 19 | import java.util.List; |
| 20 | import java.util.Objects; |
| 21 | |
alshabib | 7b808c5 | 2015-06-26 14:22:24 -0700 | [diff] [blame] | 22 | import org.onlab.packet.EthType; |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 23 | import org.onlab.packet.IpAddress; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 24 | import org.onlab.packet.MacAddress; |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 25 | import org.onlab.packet.MplsLabel; |
Hyunsun Moon | cf732fb | 2015-08-22 21:04:23 -0700 | [diff] [blame] | 26 | import org.onlab.packet.TpPort; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 27 | import org.onlab.packet.VlanId; |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 28 | import org.onosproject.core.GroupId; |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 29 | import org.onosproject.net.DeviceId; |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 30 | import org.onosproject.net.PortNumber; |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 31 | import org.onosproject.net.flow.instructions.ExtensionTreatment; |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 32 | import org.onosproject.net.flow.instructions.Instruction; |
| 33 | import org.onosproject.net.flow.instructions.Instructions; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 34 | import org.onosproject.net.meter.MeterId; |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 35 | |
Yafit Hadar | 5796d97 | 2015-10-15 13:16:11 +0300 | [diff] [blame] | 36 | import com.google.common.base.MoreObjects; |
| 37 | import com.google.common.collect.ImmutableList; |
Frank Wang | df38321 | 2017-06-23 09:17:41 +0800 | [diff] [blame^] | 38 | import org.onosproject.net.pi.runtime.PiTableAction; |
| 39 | |
Ray Milkey | 84d5a29 | 2016-02-22 14:04:01 -0800 | [diff] [blame] | 40 | import static com.google.common.base.Preconditions.checkNotNull; |
| 41 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 42 | /** |
| 43 | * Default traffic treatment implementation. |
| 44 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 45 | public final class DefaultTrafficTreatment implements TrafficTreatment { |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 46 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 47 | private final List<Instruction> immediate; |
| 48 | private final List<Instruction> deferred; |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 49 | private final List<Instruction> all; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 50 | private final Instructions.TableTypeTransition table; |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 51 | private final Instructions.MetadataInstruction meta; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 52 | |
| 53 | private final boolean hasClear; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 54 | |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 55 | private static final DefaultTrafficTreatment EMPTY |
Brian O'Connor | b75a67a | 2015-10-07 14:34:06 -0700 | [diff] [blame] | 56 | = new DefaultTrafficTreatment(ImmutableList.of(Instructions.createNoAction())); |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 57 | private final Instructions.MeterInstruction meter; |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 58 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 59 | /** |
| 60 | * Creates a new traffic treatment from the specified list of instructions. |
| 61 | * |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 62 | * @param immediate immediate instructions |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 63 | */ |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 64 | private DefaultTrafficTreatment(List<Instruction> immediate) { |
| 65 | this.immediate = ImmutableList.copyOf(checkNotNull(immediate)); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 66 | this.deferred = ImmutableList.of(); |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 67 | this.all = this.immediate; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 68 | this.hasClear = false; |
| 69 | this.table = null; |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 70 | this.meta = null; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 71 | this.meter = null; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 72 | } |
| 73 | |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 74 | /** |
| 75 | * Creates a new traffic treatment from the specified list of instructions. |
| 76 | * |
| 77 | * @param deferred deferred instructions |
| 78 | * @param immediate immediate instructions |
| 79 | * @param table table transition instruction |
| 80 | * @param clear instruction to clear the deferred actions list |
| 81 | */ |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 82 | private DefaultTrafficTreatment(List<Instruction> deferred, |
| 83 | List<Instruction> immediate, |
| 84 | Instructions.TableTypeTransition table, |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 85 | boolean clear, |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 86 | Instructions.MetadataInstruction meta, |
| 87 | Instructions.MeterInstruction meter) { |
Ray Milkey | 4250735 | 2015-03-20 15:16:10 -0700 | [diff] [blame] | 88 | this.immediate = ImmutableList.copyOf(checkNotNull(immediate)); |
| 89 | this.deferred = ImmutableList.copyOf(checkNotNull(deferred)); |
Sho SHIMIZU | d4fa7fd | 2015-06-30 18:56:05 -0700 | [diff] [blame] | 90 | this.all = new ImmutableList.Builder<Instruction>() |
| 91 | .addAll(immediate) |
| 92 | .addAll(deferred) |
| 93 | .build(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 94 | this.table = table; |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 95 | this.meta = meta; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 96 | this.hasClear = clear; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 97 | this.meter = meter; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | @Override |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 101 | public List<Instruction> deferred() { |
| 102 | return deferred; |
| 103 | } |
| 104 | |
| 105 | @Override |
| 106 | public List<Instruction> immediate() { |
| 107 | return immediate; |
| 108 | } |
| 109 | |
| 110 | @Override |
Jonathan Hart | 8ef6d3b | 2015-03-08 21:21:27 -0700 | [diff] [blame] | 111 | public List<Instruction> allInstructions() { |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 112 | return all; |
Jonathan Hart | 8ef6d3b | 2015-03-08 21:21:27 -0700 | [diff] [blame] | 113 | } |
| 114 | |
| 115 | @Override |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 116 | public Instructions.TableTypeTransition tableTransition() { |
| 117 | return table; |
| 118 | } |
| 119 | |
| 120 | @Override |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 121 | public boolean clearedDeferred() { |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 122 | return hasClear; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 123 | } |
| 124 | |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 125 | @Override |
| 126 | public Instructions.MetadataInstruction writeMetadata() { |
| 127 | return meta; |
| 128 | } |
| 129 | |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 130 | @Override |
| 131 | public Instructions.MeterInstruction metered() { |
| 132 | return meter; |
| 133 | } |
| 134 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 135 | /** |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 136 | * Returns a new traffic treatment builder. |
| 137 | * |
| 138 | * @return traffic treatment builder |
| 139 | */ |
| 140 | public static TrafficTreatment.Builder builder() { |
| 141 | return new Builder(); |
| 142 | } |
| 143 | |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 144 | /** |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 145 | * Returns an empty traffic treatment. |
| 146 | * |
| 147 | * @return empty traffic treatment |
| 148 | */ |
| 149 | public static TrafficTreatment emptyTreatment() { |
| 150 | return EMPTY; |
| 151 | } |
| 152 | |
| 153 | /** |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 154 | * Returns a new traffic treatment builder primed to produce entities |
| 155 | * patterned after the supplied treatment. |
| 156 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 157 | * @param treatment base treatment |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 158 | * @return traffic treatment builder |
| 159 | */ |
| 160 | public static TrafficTreatment.Builder builder(TrafficTreatment treatment) { |
| 161 | return new Builder(treatment); |
| 162 | } |
| 163 | |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 164 | //FIXME: Order of instructions may affect hashcode |
| 165 | @Override |
| 166 | public int hashCode() { |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 167 | return Objects.hash(immediate, deferred, table, meta); |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | @Override |
| 171 | public boolean equals(Object obj) { |
| 172 | if (this == obj) { |
| 173 | return true; |
| 174 | } |
| 175 | if (obj instanceof DefaultTrafficTreatment) { |
| 176 | DefaultTrafficTreatment that = (DefaultTrafficTreatment) obj; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 177 | return Objects.equals(immediate, that.immediate) && |
| 178 | Objects.equals(deferred, that.deferred) && |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 179 | Objects.equals(table, that.table) && |
| 180 | Objects.equals(meta, that.meta); |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 181 | |
| 182 | } |
| 183 | return false; |
| 184 | } |
| 185 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 186 | @Override |
| 187 | public String toString() { |
| 188 | return MoreObjects.toStringHelper(getClass()) |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 189 | .add("immediate", immediate) |
| 190 | .add("deferred", deferred) |
| 191 | .add("transition", table == null ? "None" : table.toString()) |
Konstantinos Kanonakis | 2a3a965 | 2016-04-01 17:27:24 -0500 | [diff] [blame] | 192 | .add("meter", meter == null ? "None" : meter.toString()) |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 193 | .add("cleared", hasClear) |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 194 | .add("metadata", meta) |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 195 | .toString(); |
| 196 | } |
| 197 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 198 | /** |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 199 | * Builds a list of treatments following the following order. |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 200 | * Modifications -> Group -> Output (including drop) |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 201 | */ |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 202 | public static final class Builder implements TrafficTreatment.Builder { |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 203 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 204 | boolean clear = false; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 205 | |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 206 | Instructions.TableTypeTransition table; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 207 | |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 208 | Instructions.MetadataInstruction meta; |
| 209 | |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 210 | Instructions.MeterInstruction meter; |
| 211 | |
Yuta HIGUCHI | 6ee6b8c | 2017-05-09 14:44:30 -0700 | [diff] [blame] | 212 | List<Instruction> deferred = new ArrayList<>(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 213 | |
Yuta HIGUCHI | 6ee6b8c | 2017-05-09 14:44:30 -0700 | [diff] [blame] | 214 | List<Instruction> immediate = new ArrayList<>(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 215 | |
| 216 | List<Instruction> current = immediate; |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 217 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 218 | // Creates a new builder |
| 219 | private Builder() { |
| 220 | } |
| 221 | |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 222 | // Creates a new builder based off an existing treatment |
| 223 | private Builder(TrafficTreatment treatment) { |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 224 | deferred(); |
| 225 | treatment.deferred().forEach(i -> add(i)); |
| 226 | |
| 227 | immediate(); |
Brian O'Connor | b75a67a | 2015-10-07 14:34:06 -0700 | [diff] [blame] | 228 | treatment.immediate().stream() |
| 229 | // NOACTION will get re-added if there are no other actions |
| 230 | .filter(i -> i.type() != Instruction.Type.NOACTION) |
| 231 | .forEach(i -> add(i)); |
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 232 | |
| 233 | clear = treatment.clearedDeferred(); |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 234 | } |
| 235 | |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 236 | @Override |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 237 | public Builder add(Instruction instruction) { |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 238 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 239 | switch (instruction.type()) { |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 240 | case NOACTION: |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 241 | case OUTPUT: |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 242 | case GROUP: |
Steffen Gebert | bbfdaaa | 2015-09-29 11:01:46 +0200 | [diff] [blame] | 243 | case QUEUE: |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 244 | case L0MODIFICATION: |
Yafit Hadar | 5796d97 | 2015-10-15 13:16:11 +0300 | [diff] [blame] | 245 | case L1MODIFICATION: |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 246 | case L2MODIFICATION: |
| 247 | case L3MODIFICATION: |
Hyunsun Moon | c8bd97c | 2015-07-18 22:47:33 -0700 | [diff] [blame] | 248 | case L4MODIFICATION: |
Frank Wang | df38321 | 2017-06-23 09:17:41 +0800 | [diff] [blame^] | 249 | case PROTOCOL_INDEPENDENT: |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 250 | case EXTENSION: |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 251 | current.add(instruction); |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 252 | break; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 253 | case TABLE: |
| 254 | table = (Instructions.TableTypeTransition) instruction; |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 255 | break; |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 256 | case METADATA: |
| 257 | meta = (Instructions.MetadataInstruction) instruction; |
| 258 | break; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 259 | case METER: |
| 260 | meter = (Instructions.MeterInstruction) instruction; |
chengfan | e264bef | 2015-09-28 08:38:19 +0800 | [diff] [blame] | 261 | break; |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 262 | default: |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 263 | throw new IllegalArgumentException("Unknown instruction type: " + |
| 264 | instruction.type()); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 265 | } |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 266 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 267 | return this; |
| 268 | } |
| 269 | |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 270 | /** |
| 271 | * Add a NOACTION when DROP instruction is explicitly specified. |
| 272 | * |
| 273 | * @return the traffic treatment builder |
| 274 | */ |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 275 | @Override |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 276 | public Builder drop() { |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 277 | return add(Instructions.createNoAction()); |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Add a NOACTION when no instruction is specified. |
| 282 | * |
| 283 | * @return the traffic treatment builder |
| 284 | */ |
| 285 | private Builder noAction() { |
| 286 | return add(Instructions.createNoAction()); |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 287 | } |
| 288 | |
| 289 | @Override |
| 290 | public Builder punt() { |
| 291 | return add(Instructions.createOutput(PortNumber.CONTROLLER)); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 292 | } |
| 293 | |
| 294 | @Override |
| 295 | public Builder setOutput(PortNumber number) { |
| 296 | return add(Instructions.createOutput(number)); |
| 297 | } |
| 298 | |
| 299 | @Override |
| 300 | public Builder setEthSrc(MacAddress addr) { |
| 301 | return add(Instructions.modL2Src(addr)); |
| 302 | } |
| 303 | |
| 304 | @Override |
| 305 | public Builder setEthDst(MacAddress addr) { |
| 306 | return add(Instructions.modL2Dst(addr)); |
| 307 | } |
| 308 | |
| 309 | @Override |
| 310 | public Builder setVlanId(VlanId id) { |
| 311 | return add(Instructions.modVlanId(id)); |
| 312 | } |
| 313 | |
| 314 | @Override |
| 315 | public Builder setVlanPcp(Byte pcp) { |
| 316 | return add(Instructions.modVlanPcp(pcp)); |
| 317 | } |
| 318 | |
| 319 | @Override |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 320 | public Builder setIpSrc(IpAddress addr) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 321 | return add(Instructions.modL3Src(addr)); |
| 322 | } |
| 323 | |
| 324 | @Override |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 325 | public Builder setIpDst(IpAddress addr) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 326 | return add(Instructions.modL3Dst(addr)); |
| 327 | } |
| 328 | |
| 329 | @Override |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 330 | public Builder decNwTtl() { |
| 331 | return add(Instructions.decNwTtl()); |
| 332 | } |
| 333 | |
| 334 | @Override |
| 335 | public Builder copyTtlIn() { |
| 336 | return add(Instructions.copyTtlIn()); |
| 337 | } |
| 338 | |
| 339 | @Override |
| 340 | public Builder copyTtlOut() { |
| 341 | return add(Instructions.copyTtlOut()); |
| 342 | } |
| 343 | |
| 344 | @Override |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 345 | public Builder pushMpls() { |
| 346 | return add(Instructions.pushMpls()); |
| 347 | } |
| 348 | |
| 349 | @Override |
| 350 | public Builder popMpls() { |
| 351 | return add(Instructions.popMpls()); |
| 352 | } |
| 353 | |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 354 | @Override |
alshabib | 7b808c5 | 2015-06-26 14:22:24 -0700 | [diff] [blame] | 355 | public Builder popMpls(EthType etherType) { |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 356 | return add(Instructions.popMpls(etherType)); |
| 357 | } |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 358 | |
| 359 | @Override |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 360 | public Builder setMpls(MplsLabel mplsLabel) { |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 361 | return add(Instructions.modMplsLabel(mplsLabel)); |
| 362 | } |
| 363 | |
| 364 | @Override |
Saurav Das | 73a7dd4 | 2015-08-19 22:20:31 -0700 | [diff] [blame] | 365 | public Builder setMplsBos(boolean mplsBos) { |
| 366 | return add(Instructions.modMplsBos(mplsBos)); |
| 367 | } |
| 368 | |
| 369 | @Override |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 370 | public Builder decMplsTtl() { |
| 371 | return add(Instructions.decMplsTtl()); |
| 372 | } |
| 373 | |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 374 | |
| 375 | @Override |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 376 | public Builder group(GroupId groupId) { |
| 377 | return add(Instructions.createGroup(groupId)); |
| 378 | } |
| 379 | |
| 380 | @Override |
Steffen Gebert | bbfdaaa | 2015-09-29 11:01:46 +0200 | [diff] [blame] | 381 | public Builder setQueue(long queueId) { |
Steffen Gebert | ba2d3b7 | 2015-10-22 11:14:31 +0200 | [diff] [blame] | 382 | return add(Instructions.setQueue(queueId, null)); |
| 383 | } |
| 384 | |
| 385 | @Override |
| 386 | public Builder setQueue(long queueId, PortNumber port) { |
| 387 | return add(Instructions.setQueue(queueId, port)); |
Steffen Gebert | bbfdaaa | 2015-09-29 11:01:46 +0200 | [diff] [blame] | 388 | } |
| 389 | |
| 390 | @Override |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 391 | public TrafficTreatment.Builder meter(MeterId meterId) { |
| 392 | return add(Instructions.meterTraffic(meterId)); |
| 393 | } |
| 394 | |
| 395 | @Override |
Saurav Das | fbe25c5 | 2015-03-04 11:12:00 -0800 | [diff] [blame] | 396 | public Builder popVlan() { |
| 397 | return add(Instructions.popVlan()); |
| 398 | } |
| 399 | |
| 400 | @Override |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 401 | public Builder pushVlan() { |
| 402 | return add(Instructions.pushVlan()); |
| 403 | } |
| 404 | |
| 405 | @Override |
Konstantinos Kanonakis | 9215ff2 | 2016-11-04 13:28:11 -0500 | [diff] [blame] | 406 | public Builder pushVlan(EthType ethType) { |
| 407 | return add(Instructions.pushVlan(ethType)); |
| 408 | } |
| 409 | |
| 410 | @Override |
alshabib | d17abc2 | 2015-04-21 18:26:35 -0700 | [diff] [blame] | 411 | public Builder transition(Integer tableId) { |
| 412 | return add(Instructions.transition(tableId)); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 413 | } |
| 414 | |
| 415 | @Override |
| 416 | public Builder immediate() { |
| 417 | current = immediate; |
| 418 | return this; |
| 419 | } |
| 420 | |
| 421 | @Override |
| 422 | public Builder deferred() { |
| 423 | current = deferred; |
| 424 | return this; |
| 425 | } |
| 426 | |
| 427 | @Override |
| 428 | public Builder wipeDeferred() { |
| 429 | clear = true; |
| 430 | return this; |
| 431 | } |
| 432 | |
| 433 | @Override |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 434 | public Builder writeMetadata(long metadata, long metadataMask) { |
| 435 | return add(Instructions.writeMetadata(metadata, metadataMask)); |
| 436 | } |
| 437 | |
| 438 | @Override |
Hyunsun Moon | a08c5d0 | 2015-07-14 17:53:00 -0700 | [diff] [blame] | 439 | public Builder setTunnelId(long tunnelId) { |
| 440 | return add(Instructions.modTunnelId(tunnelId)); |
| 441 | } |
| 442 | |
Hyunsun Moon | c8bd97c | 2015-07-18 22:47:33 -0700 | [diff] [blame] | 443 | @Override |
Hyunsun Moon | cf732fb | 2015-08-22 21:04:23 -0700 | [diff] [blame] | 444 | public TrafficTreatment.Builder setTcpSrc(TpPort port) { |
| 445 | return add(Instructions.modTcpSrc(port)); |
| 446 | } |
| 447 | |
Hyunsun Moon | c8bd97c | 2015-07-18 22:47:33 -0700 | [diff] [blame] | 448 | @Override |
Hyunsun Moon | cf732fb | 2015-08-22 21:04:23 -0700 | [diff] [blame] | 449 | public TrafficTreatment.Builder setTcpDst(TpPort port) { |
| 450 | return add(Instructions.modTcpDst(port)); |
| 451 | } |
| 452 | |
Hyunsun Moon | c8bd97c | 2015-07-18 22:47:33 -0700 | [diff] [blame] | 453 | @Override |
Hyunsun Moon | cf732fb | 2015-08-22 21:04:23 -0700 | [diff] [blame] | 454 | public TrafficTreatment.Builder setUdpSrc(TpPort port) { |
| 455 | return add(Instructions.modUdpSrc(port)); |
| 456 | } |
| 457 | |
Hyunsun Moon | c8bd97c | 2015-07-18 22:47:33 -0700 | [diff] [blame] | 458 | @Override |
Hyunsun Moon | cf732fb | 2015-08-22 21:04:23 -0700 | [diff] [blame] | 459 | public TrafficTreatment.Builder setUdpDst(TpPort port) { |
| 460 | return add(Instructions.modUdpDst(port)); |
| 461 | } |
| 462 | |
| 463 | @Override |
lishuai | 3cce60b | 2015-12-01 19:35:16 +0800 | [diff] [blame] | 464 | public Builder setArpSpa(IpAddress addr) { |
| 465 | return add(Instructions.modArpSpa(addr)); |
| 466 | } |
| 467 | |
| 468 | @Override |
| 469 | public Builder setArpSha(MacAddress addr) { |
| 470 | return add(Instructions.modArpSha(addr)); |
| 471 | } |
| 472 | |
| 473 | @Override |
| 474 | public Builder setArpOp(short op) { |
| 475 | return add(Instructions.modL3ArpOp(op)); |
| 476 | } |
| 477 | |
| 478 | @Override |
Frank Wang | df38321 | 2017-06-23 09:17:41 +0800 | [diff] [blame^] | 479 | public Builder piTableAction(PiTableAction piTableAction) { |
| 480 | return add(Instructions.piTableAction(piTableAction)); |
| 481 | } |
| 482 | |
| 483 | @Override |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 484 | public TrafficTreatment.Builder extension(ExtensionTreatment extension, |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 485 | DeviceId deviceId) { |
| 486 | return add(Instructions.extension(extension, deviceId)); |
| 487 | } |
| 488 | |
| 489 | @Override |
Yi Tseng | 2a81c9d | 2016-09-14 10:14:24 -0700 | [diff] [blame] | 490 | public TrafficTreatment.Builder addTreatment(TrafficTreatment treatment) { |
| 491 | List<Instruction> previous = current; |
| 492 | deferred(); |
| 493 | treatment.deferred().forEach(i -> add(i)); |
| 494 | |
| 495 | immediate(); |
| 496 | treatment.immediate().stream() |
| 497 | // NOACTION will get re-added if there are no other actions |
| 498 | .filter(i -> i.type() != Instruction.Type.NOACTION) |
| 499 | .forEach(i -> add(i)); |
| 500 | |
| 501 | clear = treatment.clearedDeferred(); |
| 502 | current = previous; |
| 503 | return this; |
| 504 | } |
| 505 | |
| 506 | @Override |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 507 | public TrafficTreatment build() { |
Jon Hall | cbd1b39 | 2017-01-18 20:15:44 -0800 | [diff] [blame] | 508 | if (deferred.isEmpty() && immediate.isEmpty() |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 509 | && table == null && !clear) { |
Brian O'Connor | b75a67a | 2015-10-07 14:34:06 -0700 | [diff] [blame] | 510 | immediate(); |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 511 | noAction(); |
| 512 | } |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 513 | return new DefaultTrafficTreatment(deferred, immediate, table, clear, meta, meter); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 514 | } |
| 515 | |
| 516 | } |
| 517 | |
| 518 | } |