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; |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 20 | import org.onlab.packet.IpAddress; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 21 | import org.onlab.packet.MacAddress; |
| 22 | import org.onlab.packet.VlanId; |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 23 | import org.onosproject.core.GroupId; |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 24 | import org.onosproject.net.PortNumber; |
| 25 | import org.onosproject.net.flow.instructions.Instruction; |
| 26 | import org.onosproject.net.flow.instructions.Instructions; |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 27 | |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 28 | import java.util.LinkedList; |
| 29 | import java.util.List; |
| 30 | import java.util.Objects; |
Yuta HIGUCHI | 2809bf3 | 2014-10-20 22:44:12 -0700 | [diff] [blame] | 31 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 32 | /** |
| 33 | * Default traffic treatment implementation. |
| 34 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 35 | public final class DefaultTrafficTreatment implements TrafficTreatment { |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 36 | |
| 37 | private final List<Instruction> instructions; |
| 38 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 39 | /** |
| 40 | * Creates a new traffic treatment from the specified list of instructions. |
| 41 | * |
| 42 | * @param instructions treatment instructions |
| 43 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 44 | private DefaultTrafficTreatment(List<Instruction> instructions) { |
Yuta HIGUCHI | 2809bf3 | 2014-10-20 22:44:12 -0700 | [diff] [blame] | 45 | this.instructions = ImmutableList.copyOf(instructions); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | @Override |
| 49 | public List<Instruction> instructions() { |
| 50 | return instructions; |
| 51 | } |
| 52 | |
| 53 | /** |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 54 | * Returns a new traffic treatment builder. |
| 55 | * |
| 56 | * @return traffic treatment builder |
| 57 | */ |
| 58 | public static TrafficTreatment.Builder builder() { |
| 59 | return new Builder(); |
| 60 | } |
| 61 | |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 62 | /** |
| 63 | * Returns a new traffic treatment builder primed to produce entities |
| 64 | * patterned after the supplied treatment. |
| 65 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 66 | * @param treatment base treatment |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 67 | * @return traffic treatment builder |
| 68 | */ |
| 69 | public static TrafficTreatment.Builder builder(TrafficTreatment treatment) { |
| 70 | return new Builder(treatment); |
| 71 | } |
| 72 | |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 73 | //FIXME: Order of instructions may affect hashcode |
| 74 | @Override |
| 75 | public int hashCode() { |
| 76 | return Objects.hash(instructions); |
| 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public boolean equals(Object obj) { |
| 81 | if (this == obj) { |
| 82 | return true; |
| 83 | } |
| 84 | if (obj instanceof DefaultTrafficTreatment) { |
| 85 | DefaultTrafficTreatment that = (DefaultTrafficTreatment) obj; |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 86 | return Objects.equals(instructions, that.instructions); |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 87 | |
| 88 | } |
| 89 | return false; |
| 90 | } |
| 91 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 92 | @Override |
| 93 | public String toString() { |
| 94 | return MoreObjects.toStringHelper(getClass()) |
| 95 | .add("instructions", instructions) |
| 96 | .toString(); |
| 97 | } |
| 98 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 99 | /** |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 100 | * Builds a list of treatments following the following order. |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 101 | * Modifications -> Group -> Output (including drop) |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 102 | */ |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 103 | public static final class Builder implements TrafficTreatment.Builder { |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 104 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 105 | boolean drop = false; |
| 106 | |
| 107 | List<Instruction> outputs = new LinkedList<>(); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 108 | |
| 109 | // TODO: should be a list of instructions based on group objects |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 110 | List<Instruction> groups = new LinkedList<>(); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 111 | |
| 112 | // TODO: should be a list of instructions based on modification objects |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 113 | List<Instruction> modifications = new LinkedList<>(); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 114 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 115 | // Creates a new builder |
| 116 | private Builder() { |
| 117 | } |
| 118 | |
Jonathan Hart | 6e88c68 | 2014-10-21 17:05:25 -0700 | [diff] [blame] | 119 | // Creates a new builder based off an existing treatment |
| 120 | private Builder(TrafficTreatment treatment) { |
| 121 | for (Instruction instruction : treatment.instructions()) { |
| 122 | add(instruction); |
| 123 | } |
| 124 | } |
| 125 | |
alshabib | 8ca5390 | 2014-10-07 13:11:17 -0700 | [diff] [blame] | 126 | @Override |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 127 | public Builder add(Instruction instruction) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 128 | if (drop) { |
| 129 | return this; |
| 130 | } |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 131 | switch (instruction.type()) { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 132 | case DROP: |
| 133 | drop = true; |
| 134 | break; |
| 135 | case OUTPUT: |
| 136 | outputs.add(instruction); |
| 137 | break; |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 138 | case L0MODIFICATION: |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 139 | case L2MODIFICATION: |
| 140 | case L3MODIFICATION: |
| 141 | // TODO: enforce modification order if any |
| 142 | modifications.add(instruction); |
| 143 | break; |
| 144 | case GROUP: |
| 145 | groups.add(instruction); |
| 146 | break; |
| 147 | default: |
tom | 1679e18 | 2014-10-09 13:50:45 -0700 | [diff] [blame] | 148 | throw new IllegalArgumentException("Unknown instruction type: " + |
| 149 | instruction.type()); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 150 | } |
| 151 | return this; |
| 152 | } |
| 153 | |
| 154 | @Override |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 155 | public Builder drop() { |
| 156 | return add(Instructions.createDrop()); |
| 157 | } |
| 158 | |
| 159 | @Override |
| 160 | public Builder punt() { |
| 161 | return add(Instructions.createOutput(PortNumber.CONTROLLER)); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | @Override |
| 165 | public Builder setOutput(PortNumber number) { |
| 166 | return add(Instructions.createOutput(number)); |
| 167 | } |
| 168 | |
| 169 | @Override |
| 170 | public Builder setEthSrc(MacAddress addr) { |
| 171 | return add(Instructions.modL2Src(addr)); |
| 172 | } |
| 173 | |
| 174 | @Override |
| 175 | public Builder setEthDst(MacAddress addr) { |
| 176 | return add(Instructions.modL2Dst(addr)); |
| 177 | } |
| 178 | |
| 179 | @Override |
| 180 | public Builder setVlanId(VlanId id) { |
| 181 | return add(Instructions.modVlanId(id)); |
| 182 | } |
| 183 | |
| 184 | @Override |
| 185 | public Builder setVlanPcp(Byte pcp) { |
| 186 | return add(Instructions.modVlanPcp(pcp)); |
| 187 | } |
| 188 | |
| 189 | @Override |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 190 | public Builder setIpSrc(IpAddress addr) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 191 | return add(Instructions.modL3Src(addr)); |
| 192 | } |
| 193 | |
| 194 | @Override |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 195 | public Builder setIpDst(IpAddress addr) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 196 | return add(Instructions.modL3Dst(addr)); |
| 197 | } |
| 198 | |
| 199 | @Override |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 200 | public Builder decNwTtl() { |
| 201 | return add(Instructions.decNwTtl()); |
| 202 | } |
| 203 | |
| 204 | @Override |
| 205 | public Builder copyTtlIn() { |
| 206 | return add(Instructions.copyTtlIn()); |
| 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public Builder copyTtlOut() { |
| 211 | return add(Instructions.copyTtlOut()); |
| 212 | } |
| 213 | |
| 214 | @Override |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 215 | public Builder pushMpls() { |
| 216 | return add(Instructions.pushMpls()); |
| 217 | } |
| 218 | |
| 219 | @Override |
| 220 | public Builder popMpls() { |
| 221 | return add(Instructions.popMpls()); |
| 222 | } |
| 223 | |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 224 | @Override |
| 225 | public Builder popMpls(short etherType) { |
| 226 | return add(Instructions.popMpls(etherType)); |
| 227 | } |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 228 | |
| 229 | @Override |
| 230 | public Builder setMpls(Integer mplsLabel) { |
| 231 | return add(Instructions.modMplsLabel(mplsLabel)); |
| 232 | } |
| 233 | |
| 234 | @Override |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 235 | public Builder decMplsTtl() { |
| 236 | return add(Instructions.decMplsTtl()); |
| 237 | } |
| 238 | |
| 239 | @Override |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 240 | public Builder setLambda(short lambda) { |
| 241 | return add(Instructions.modL0Lambda(lambda)); |
| 242 | } |
| 243 | |
| 244 | @Override |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 245 | public Builder group(GroupId groupId) { |
| 246 | return add(Instructions.createGroup(groupId)); |
| 247 | } |
| 248 | |
| 249 | @Override |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 250 | public TrafficTreatment build() { |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 251 | |
Jonathan Hart | 86e5935 | 2014-10-22 10:42:16 -0700 | [diff] [blame] | 252 | //If we are dropping should we just return an empty list? |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 253 | List<Instruction> instructions = new LinkedList<Instruction>(); |
| 254 | instructions.addAll(modifications); |
| 255 | instructions.addAll(groups); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 256 | if (!drop) { |
| 257 | instructions.addAll(outputs); |
| 258 | } |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 259 | |
| 260 | return new DefaultTrafficTreatment(instructions); |
| 261 | } |
| 262 | |
| 263 | } |
| 264 | |
| 265 | } |