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; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 17 | |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 18 | import org.onlab.packet.IpAddress; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 19 | import org.onlab.packet.MacAddress; |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 20 | import org.onlab.packet.MplsLabel; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 21 | import org.onlab.packet.VlanId; |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 22 | import org.onosproject.core.GroupId; |
| 23 | import org.onosproject.net.PortNumber; |
| 24 | import org.onosproject.net.flow.instructions.Instruction; |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 25 | import org.onosproject.net.flow.instructions.Instructions; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 26 | |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 27 | import java.util.List; |
| 28 | |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 29 | /** |
| 30 | * Abstraction of network traffic treatment. |
| 31 | */ |
| 32 | public interface TrafficTreatment { |
| 33 | |
| 34 | /** |
| 35 | * Returns list of instructions on how to treat traffic. |
| 36 | * |
| 37 | * @return list of treatment instructions |
| 38 | */ |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 39 | @Deprecated |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 40 | List<Instruction> instructions(); |
| 41 | |
| 42 | /** |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 43 | * Returns the list of treatment instructions that will be applied |
| 44 | * further down the pipeline. |
| 45 | * @return list of treatment instructions |
| 46 | */ |
| 47 | List<Instruction> deferred(); |
| 48 | |
| 49 | /** |
| 50 | * Returns the list of treatment instructions that will be applied |
| 51 | * immediately. |
| 52 | * @return list of treatment instructions |
| 53 | */ |
| 54 | List<Instruction> immediate(); |
| 55 | |
| 56 | /** |
Jonathan Hart | 8ef6d3b | 2015-03-08 21:21:27 -0700 | [diff] [blame] | 57 | * Returns the list of all instructions in the treatment, both immediate and |
| 58 | * deferred. |
| 59 | * |
| 60 | * @return list of treatment instructions |
| 61 | */ |
| 62 | List<Instruction> allInstructions(); |
| 63 | |
| 64 | /** |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 65 | * Returns the next table in the pipeline. |
| 66 | * @return a table transition; may be null. |
| 67 | */ |
| 68 | Instructions.TableTypeTransition tableTransition(); |
| 69 | |
| 70 | /** |
| 71 | * Whether the deferred treatment instructions will be cleared |
| 72 | * by the device. |
| 73 | * @return a boolean |
| 74 | */ |
| 75 | Boolean clearedDeferred(); |
| 76 | |
| 77 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 78 | * Builder of traffic treatment entities. |
| 79 | */ |
| 80 | public interface Builder { |
| 81 | |
| 82 | /** |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 83 | * Adds an instruction to the builder. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 84 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 85 | * @param instruction an instruction |
| 86 | * @return a treatment builder |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 87 | */ |
alshabib | 369d294 | 2014-09-12 17:59:35 -0700 | [diff] [blame] | 88 | Builder add(Instruction instruction); |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 89 | |
| 90 | /** |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 91 | * Adds a drop instruction. |
| 92 | * |
| 93 | * @return a treatment builder |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 94 | */ |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 95 | public Builder drop(); |
| 96 | |
| 97 | /** |
| 98 | * Adds a punt-to-controller instruction. |
| 99 | * |
| 100 | * @return a treatment builder |
| 101 | */ |
| 102 | public Builder punt(); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 103 | |
| 104 | /** |
| 105 | * Set the output port. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 106 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 107 | * @param number the out port |
| 108 | * @return a treatment builder |
| 109 | */ |
| 110 | public Builder setOutput(PortNumber number); |
| 111 | |
| 112 | /** |
| 113 | * Sets the src l2 address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 114 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 115 | * @param addr a macaddress |
| 116 | * @return a treatment builder |
| 117 | */ |
| 118 | public Builder setEthSrc(MacAddress addr); |
| 119 | |
| 120 | /** |
| 121 | * Sets the dst l2 address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 122 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 123 | * @param addr a macaddress |
| 124 | * @return a treatment builder |
| 125 | */ |
| 126 | public Builder setEthDst(MacAddress addr); |
| 127 | |
| 128 | /** |
| 129 | * Sets the vlan id. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 130 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 131 | * @param id a vlanid |
| 132 | * @return a treatment builder |
| 133 | */ |
| 134 | public Builder setVlanId(VlanId id); |
| 135 | |
| 136 | /** |
| 137 | * Sets the vlan priority. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 138 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 139 | * @param pcp a vlan priority |
| 140 | * @return a treatment builder |
| 141 | */ |
| 142 | public Builder setVlanPcp(Byte pcp); |
| 143 | |
| 144 | /** |
| 145 | * Sets the src l3 address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 146 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 147 | * @param addr an ip |
| 148 | * @return a treatment builder |
| 149 | */ |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 150 | public Builder setIpSrc(IpAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 151 | |
| 152 | /** |
| 153 | * Sets the dst l3 address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 154 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 155 | * @param addr an ip |
| 156 | * @return a treatment builder |
| 157 | */ |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 158 | public Builder setIpDst(IpAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 159 | |
| 160 | /** |
Pavlin Radoslavov | febe82c | 2015-02-11 19:08:15 -0800 | [diff] [blame] | 161 | * Decrement the TTL in IP header by one. |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 162 | * |
| 163 | * @return a treatment builder |
| 164 | */ |
| 165 | public Builder decNwTtl(); |
| 166 | |
| 167 | /** |
| 168 | * Copy the TTL to outer protocol layer. |
| 169 | * |
| 170 | * @return a treatment builder |
| 171 | */ |
| 172 | public Builder copyTtlOut(); |
| 173 | |
| 174 | /** |
| 175 | * Copy the TTL to inner protocol layer. |
| 176 | * |
| 177 | * @return a treatment builder |
| 178 | */ |
| 179 | public Builder copyTtlIn(); |
| 180 | |
| 181 | /** |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 182 | * Push MPLS ether type. |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 183 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 184 | * @return a treatment builder. |
| 185 | */ |
| 186 | public Builder pushMpls(); |
| 187 | |
| 188 | /** |
| 189 | * Pops MPLS ether type. |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 190 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 191 | * @return a treatment builder. |
| 192 | */ |
| 193 | public Builder popMpls(); |
| 194 | |
| 195 | /** |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 196 | * Pops MPLS ether type and set the new ethertype. |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 197 | * |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 198 | * @param etherType an ether type |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 199 | * @return a treatment builder. |
| 200 | */ |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 201 | public Builder popMpls(Short etherType); |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 202 | |
| 203 | /** |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 204 | * Sets the mpls label. |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 205 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 206 | * @param mplsLabel MPLS label. |
| 207 | * @return a treatment builder. |
| 208 | */ |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 209 | public Builder setMpls(MplsLabel mplsLabel); |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 210 | |
| 211 | /** |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 212 | * Decrement MPLS TTL. |
| 213 | * |
| 214 | * @return a treatment builder |
| 215 | */ |
| 216 | public Builder decMplsTtl(); |
| 217 | |
| 218 | /** |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 219 | * Sets the optical channel ID or lambda. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 220 | * |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 221 | * @param lambda optical channel ID |
| 222 | * @return a treatment builder |
| 223 | */ |
| 224 | public Builder setLambda(short lambda); |
| 225 | |
| 226 | /** |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 227 | * Sets the group ID. |
| 228 | * |
| 229 | * @param groupId group ID |
| 230 | * @return a treatment builder |
| 231 | */ |
| 232 | public Builder group(GroupId groupId); |
| 233 | |
alshabib | 9af7007 | 2015-02-09 14:34:16 -0800 | [diff] [blame] | 234 | |
| 235 | /** |
| 236 | * Sets the next table type to transition to. |
| 237 | * |
| 238 | * @param type the table type |
| 239 | * @return a treatement builder |
| 240 | */ |
| 241 | public Builder transition(FlowRule.Type type); |
| 242 | |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 243 | /** |
Saurav Das | fbe25c5 | 2015-03-04 11:12:00 -0800 | [diff] [blame] | 244 | * Pops outermost VLAN tag. |
| 245 | * |
| 246 | * @return a treatment builder. |
| 247 | */ |
| 248 | public Builder popVlan(); |
| 249 | |
| 250 | /** |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 251 | * Pushes a new VLAN tag. |
| 252 | * |
| 253 | * @return a treatment builder. |
| 254 | */ |
| 255 | public Builder pushVlan(); |
| 256 | |
| 257 | /** |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 258 | * Any instructions preceded by this method call will be deferred. |
| 259 | * @return a treatment builder |
| 260 | */ |
| 261 | public Builder deferred(); |
| 262 | |
| 263 | /** |
| 264 | * Any instructions preceded by this method call will be immediate. |
| 265 | * @return a treatment builder |
| 266 | */ |
| 267 | public Builder immediate(); |
| 268 | |
| 269 | |
| 270 | /** |
| 271 | * Instructs the device to clear the deferred instructions set. |
| 272 | * @return a treatment builder |
| 273 | */ |
| 274 | public Builder wipeDeferred(); |
| 275 | |
| 276 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 277 | * Builds an immutable traffic treatment descriptor. |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 278 | * <p> |
| 279 | * If the treatment is empty when build() is called, it will add a default |
| 280 | * drop rule automatically. For a treatment that is actually empty, use |
| 281 | * {@link org.onosproject.net.flow.DefaultTrafficTreatment#emptyTreatment}. |
| 282 | * </p> |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 283 | * |
| 284 | * @return traffic treatment |
| 285 | */ |
| 286 | TrafficTreatment build(); |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 287 | } |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 288 | } |