Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 1 | package net.floodlightcontroller.util; |
| 2 | |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 3 | import java.util.ArrayList; |
| 4 | |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 5 | import net.floodlightcontroller.util.Dpid; |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 6 | import net.floodlightcontroller.util.FlowEntryAction; |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 7 | import net.floodlightcontroller.util.FlowEntryId; |
| 8 | import net.floodlightcontroller.util.FlowEntryMatch; |
Pavlin Radoslavov | b6f5354 | 2013-03-01 16:02:14 -0800 | [diff] [blame] | 9 | import net.floodlightcontroller.util.FlowEntrySwitchState; |
| 10 | import net.floodlightcontroller.util.FlowEntryUserState; |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 11 | import net.floodlightcontroller.util.Port; |
Pavlin Radoslavov | ad008e0 | 2013-02-21 18:42:42 -0800 | [diff] [blame] | 12 | |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 13 | import net.floodlightcontroller.util.MACAddress; |
| 14 | import net.floodlightcontroller.util.IPv4; |
| 15 | |
Pankaj Berde | d0ae0ff | 2013-03-26 15:37:12 -0700 | [diff] [blame] | 16 | import org.codehaus.jackson.annotate.JsonIgnore; |
Pavlin Radoslavov | ad008e0 | 2013-02-21 18:42:42 -0800 | [diff] [blame] | 17 | import org.codehaus.jackson.annotate.JsonProperty; |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 18 | |
| 19 | /** |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 20 | * The class representing the Flow Entry. |
| 21 | * |
| 22 | * NOTE: The specification is incomplete. E.g., the entry needs to |
| 23 | * support multiple in-ports and multiple out-ports. |
| 24 | */ |
| 25 | public class FlowEntry { |
Pankaj Berde | d0ae0ff | 2013-03-26 15:37:12 -0700 | [diff] [blame] | 26 | private FlowId flowId; //FlowID of flowEntry |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 27 | private FlowEntryId flowEntryId; // The Flow Entry ID |
| 28 | private FlowEntryMatch flowEntryMatch; // The Flow Entry Match |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 29 | private ArrayList<FlowEntryAction> flowEntryActions; // The Flow Entry Actions |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 30 | private Dpid dpid; // The Switch DPID |
Pavlin Radoslavov | fbcb97c | 2013-03-21 11:29:58 -0700 | [diff] [blame] | 31 | private Port inPort; // The Switch incoming port. Used only |
| 32 | // when the entry is used to return |
| 33 | // Shortest Path computation. |
| 34 | private Port outPort; // The Switch outgoing port. Used only |
| 35 | // when the entry is used to return |
| 36 | // Shortest Path computation. |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 37 | private FlowEntryUserState flowEntryUserState; // The Flow Entry User state |
| 38 | private FlowEntrySwitchState flowEntrySwitchState; // The Flow Entry Switch state |
| 39 | // The Flow Entry Error state (if FlowEntrySwitchState is FE_SWITCH_FAILED) |
| 40 | private FlowEntryErrorState flowEntryErrorState; |
| 41 | |
| 42 | /** |
| 43 | * Default constructor. |
| 44 | */ |
| 45 | public FlowEntry() { |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 46 | // TODO: Test code |
| 47 | /* |
| 48 | MACAddress mac = MACAddress.valueOf("01:02:03:04:05:06"); |
| 49 | IPv4 ipv4 = new IPv4("1.2.3.4"); |
| 50 | IPv4Net ipv4net = new IPv4Net("5.6.7.0/24"); |
| 51 | |
| 52 | flowEntryMatch = new FlowEntryMatch(); |
| 53 | flowEntryMatch.enableInPort(new Port((short)10)); |
| 54 | flowEntryMatch.enableSrcMac(mac); |
| 55 | flowEntryMatch.enableDstMac(mac); |
| 56 | flowEntryMatch.enableVlanId((short)20); |
| 57 | flowEntryMatch.enableVlanPriority((byte)30); |
| 58 | flowEntryMatch.enableEthernetFrameType((short)40); |
| 59 | flowEntryMatch.enableIpToS((byte)50); |
| 60 | flowEntryMatch.enableIpProto((byte)60); |
| 61 | flowEntryMatch.enableSrcIPv4Net(ipv4net); |
| 62 | flowEntryMatch.enableDstIPv4Net(ipv4net); |
| 63 | flowEntryMatch.enableSrcTcpUdpPort((short)70); |
| 64 | flowEntryMatch.enableDstTcpUdpPort((short)80); |
| 65 | |
| 66 | FlowEntryAction action = null; |
| 67 | ArrayList<FlowEntryAction> actions = new ArrayList<FlowEntryAction>(); |
| 68 | |
| 69 | action = new FlowEntryAction(); |
| 70 | action.setActionOutput(new Port((short)12)); |
| 71 | actions.add(action); |
| 72 | |
| 73 | action = new FlowEntryAction(); |
| 74 | action.setActionOutputToController((short)13); |
| 75 | actions.add(action); |
| 76 | |
| 77 | action = new FlowEntryAction(); |
| 78 | action.setActionSetVlanId((short)14); |
| 79 | actions.add(action); |
| 80 | |
| 81 | action = new FlowEntryAction(); |
| 82 | action.setActionSetVlanPriority((byte)15); |
| 83 | actions.add(action); |
| 84 | |
| 85 | action = new FlowEntryAction(); |
| 86 | action.setActionStripVlan(true); |
| 87 | actions.add(action); |
| 88 | |
| 89 | action = new FlowEntryAction(); |
| 90 | action.setActionSetEthernetSrcAddr(mac); |
| 91 | actions.add(action); |
| 92 | |
| 93 | action = new FlowEntryAction(); |
| 94 | action.setActionSetEthernetDstAddr(mac); |
| 95 | actions.add(action); |
| 96 | |
| 97 | action = new FlowEntryAction(); |
| 98 | action.setActionSetIPv4SrcAddr(ipv4); |
| 99 | actions.add(action); |
| 100 | |
| 101 | action = new FlowEntryAction(); |
| 102 | action.setActionSetIPv4DstAddr(ipv4); |
| 103 | actions.add(action); |
| 104 | |
| 105 | action = new FlowEntryAction(); |
| 106 | action.setActionSetIpToS((byte)16); |
| 107 | actions.add(action); |
| 108 | |
| 109 | action = new FlowEntryAction(); |
| 110 | action.setActionSetTcpUdpSrcPort((short)17); |
| 111 | actions.add(action); |
| 112 | |
| 113 | action = new FlowEntryAction(); |
| 114 | action.setActionSetTcpUdpDstPort((short)18); |
| 115 | actions.add(action); |
| 116 | |
| 117 | action = new FlowEntryAction(); |
| 118 | action.setActionEnqueue(new Port((short)19), 20); |
| 119 | actions.add(action); |
| 120 | |
| 121 | setFlowEntryActions(actions); |
| 122 | */ |
| 123 | |
| 124 | |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 125 | flowEntryUserState = FlowEntryUserState.FE_USER_UNKNOWN; |
| 126 | flowEntrySwitchState = FlowEntrySwitchState.FE_SWITCH_UNKNOWN; |
| 127 | } |
| 128 | |
| 129 | /** |
| 130 | * Get the Flow Entry ID. |
| 131 | * |
| 132 | * @return the Flow Entry ID. |
| 133 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 134 | @JsonProperty("flowEntryId") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 135 | public FlowEntryId flowEntryId() { return flowEntryId; } |
| 136 | |
| 137 | /** |
| 138 | * Set the Flow Entry ID. |
| 139 | * |
| 140 | * @param flowEntryId the Flow Entry ID to set. |
| 141 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 142 | @JsonProperty("flowEntryId") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 143 | public void setFlowEntryId(FlowEntryId flowEntryId) { |
| 144 | this.flowEntryId = flowEntryId; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Get the Flow Entry Match. |
| 149 | * |
| 150 | * @return the Flow Entry Match. |
| 151 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 152 | @JsonProperty("flowEntryMatch") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 153 | public FlowEntryMatch flowEntryMatch() { return flowEntryMatch; } |
| 154 | |
| 155 | /** |
| 156 | * Set the Flow Entry Match. |
| 157 | * |
| 158 | * @param flowEntryMatch the Flow Entry Match to set. |
| 159 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 160 | @JsonProperty("flowEntryMatch") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 161 | public void setFlowEntryMatch(FlowEntryMatch flowEntryMatch) { |
| 162 | this.flowEntryMatch = flowEntryMatch; |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Get the Flow Entry Actions. |
| 167 | * |
| 168 | * @return the Flow Entry Actions. |
| 169 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 170 | @JsonProperty("flowEntryActions") |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 171 | public ArrayList<FlowEntryAction> flowEntryActions() { |
| 172 | return flowEntryActions; |
| 173 | } |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 174 | |
| 175 | /** |
| 176 | * Set the Flow Entry Actions. |
| 177 | * |
| 178 | * @param flowEntryActions the Flow Entry Actions to set. |
| 179 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 180 | @JsonProperty("flowEntryActions") |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 181 | public void setFlowEntryActions(ArrayList<FlowEntryAction> flowEntryActions) { |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 182 | this.flowEntryActions = flowEntryActions; |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Get the Switch DPID. |
| 187 | * |
| 188 | * @return the Switch DPID. |
| 189 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 190 | @JsonProperty("dpid") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 191 | public Dpid dpid() { return dpid; } |
| 192 | |
| 193 | /** |
| 194 | * Set the Switch DPID. |
| 195 | * |
| 196 | * @param dpid the Switch DPID to set. |
| 197 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 198 | @JsonProperty("dpid") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 199 | public void setDpid(Dpid dpid) { |
| 200 | this.dpid = dpid; |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Get the Switch incoming port. |
| 205 | * |
| 206 | * @return the Switch incoming port. |
| 207 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 208 | @JsonProperty("inPort") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 209 | public Port inPort() { return inPort; } |
| 210 | |
| 211 | /** |
| 212 | * Set the Switch incoming port. |
| 213 | * |
| 214 | * @param inPort the Switch incoming port to set. |
| 215 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 216 | @JsonProperty("inPort") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 217 | public void setInPort(Port inPort) { |
| 218 | this.inPort = inPort; |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * Get the Switch outgoing port. |
| 223 | * |
| 224 | * @return the Switch outgoing port. |
| 225 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 226 | @JsonProperty("outPort") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 227 | public Port outPort() { return outPort; } |
| 228 | |
| 229 | /** |
| 230 | * Set the Switch outgoing port. |
| 231 | * |
| 232 | * @param outPort the Switch outgoing port to set. |
| 233 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 234 | @JsonProperty("outPort") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 235 | public void setOutPort(Port outPort) { |
| 236 | this.outPort = outPort; |
| 237 | } |
| 238 | |
| 239 | /** |
| 240 | * Get the Flow Entry User state. |
| 241 | * |
| 242 | * @return the Flow Entry User state. |
| 243 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 244 | @JsonProperty("flowEntryUserState") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 245 | public FlowEntryUserState flowEntryUserState() { |
| 246 | return flowEntryUserState; |
| 247 | } |
| 248 | |
| 249 | /** |
| 250 | * Set the Flow Entry User state. |
| 251 | * |
| 252 | * @param flowEntryUserState the Flow Entry User state to set. |
| 253 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 254 | @JsonProperty("flowEntryUserState") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 255 | public void setFlowEntryUserState(FlowEntryUserState flowEntryUserState) { |
| 256 | this.flowEntryUserState = flowEntryUserState; |
| 257 | } |
| 258 | |
| 259 | /** |
| 260 | * Get the Flow Entry Switch state. |
| 261 | * |
| 262 | * The Flow Entry Error state is used if FlowEntrySwitchState is |
| 263 | * FE_SWITCH_FAILED. |
| 264 | * |
| 265 | * @return the Flow Entry Switch state. |
| 266 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 267 | @JsonProperty("flowEntrySwitchState") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 268 | public FlowEntrySwitchState flowEntrySwitchState() { |
| 269 | return flowEntrySwitchState; |
| 270 | } |
| 271 | |
| 272 | /** |
| 273 | * Set the Flow Entry Switch state. |
| 274 | * |
| 275 | * The Flow Entry Error state is used if FlowEntrySwitchState is |
| 276 | * FE_SWITCH_FAILED. |
| 277 | * |
| 278 | * @param flowEntrySwitchState the Flow Entry Switch state to set. |
| 279 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 280 | @JsonProperty("flowEntrySwitchState") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 281 | public void setFlowEntrySwitchState(FlowEntrySwitchState flowEntrySwitchState) { |
| 282 | this.flowEntrySwitchState = flowEntrySwitchState; |
| 283 | } |
| 284 | |
| 285 | /** |
| 286 | * Get the Flow Entry Error state. |
| 287 | * |
| 288 | * @return the Flow Entry Error state. |
| 289 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 290 | @JsonProperty("flowEntryErrorState") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 291 | public FlowEntryErrorState flowEntryErrorState() { |
| 292 | return flowEntryErrorState; |
| 293 | } |
| 294 | |
| 295 | /** |
| 296 | * Set the Flow Entry Error state. |
| 297 | * |
| 298 | * @param flowEntryErrorState the Flow Entry Error state to set. |
| 299 | */ |
Pavlin Radoslavov | 2013cbb | 2013-02-26 10:15:18 -0800 | [diff] [blame] | 300 | @JsonProperty("flowEntryErrorState") |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 301 | public void setFlowEntryErrorState(FlowEntryErrorState flowEntryErrorState) { |
| 302 | this.flowEntryErrorState = flowEntryErrorState; |
| 303 | } |
| 304 | |
| 305 | /** |
| 306 | * Convert the flow entry to a string. |
| 307 | * |
Pavlin Radoslavov | ad008e0 | 2013-02-21 18:42:42 -0800 | [diff] [blame] | 308 | * The string has the following form: |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 309 | * [flowEntryId=XXX flowEntryMatch=XXX flowEntryAction=XXX |
| 310 | * flowEntryAction=XXX flowEntryAction=XXX dpid=XXX |
Pavlin Radoslavov | a10a9a8 | 2013-02-22 11:47:54 -0800 | [diff] [blame] | 311 | * inPort=XXX outPort=XXX flowEntryUserState=XXX flowEntrySwitchState=XXX |
| 312 | * flowEntryErrorState=XXX] |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 313 | * @return the flow entry as a string. |
| 314 | */ |
| 315 | @Override |
| 316 | public String toString() { |
Pavlin Radoslavov | a10a9a8 | 2013-02-22 11:47:54 -0800 | [diff] [blame] | 317 | String ret = "[flowEntryId=" + this.flowEntryId.toString(); |
| 318 | ret += " flowEntryMatch=" + this.flowEntryMatch.toString(); |
Pavlin Radoslavov | ede9758 | 2013-03-08 18:57:28 -0800 | [diff] [blame] | 319 | for (FlowEntryAction fa : flowEntryActions) { |
| 320 | ret += " flowEntryAction=" + fa.toString(); |
| 321 | } |
Pavlin Radoslavov | a10a9a8 | 2013-02-22 11:47:54 -0800 | [diff] [blame] | 322 | ret += " dpid=" + this.dpid.toString(); |
| 323 | ret += " inPort=" + this.inPort.toString(); |
| 324 | ret += " outPort=" + this.outPort.toString(); |
| 325 | ret += " flowEntryUserState=" + this.flowEntryUserState; |
| 326 | ret += " flowEntrySwitchState=" + this.flowEntrySwitchState; |
| 327 | ret += " flowEntryErrorState=" + this.flowEntryErrorState.toString(); |
Pavlin Radoslavov | ad008e0 | 2013-02-21 18:42:42 -0800 | [diff] [blame] | 328 | ret += "]"; |
| 329 | |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 330 | return ret; |
| 331 | } |
Pankaj Berde | d0ae0ff | 2013-03-26 15:37:12 -0700 | [diff] [blame] | 332 | |
| 333 | /** |
| 334 | * @return the flowId |
| 335 | */ |
| 336 | @JsonIgnore |
| 337 | public FlowId getFlowId() { |
| 338 | return flowId; |
| 339 | } |
| 340 | |
| 341 | /** |
| 342 | * @param flowId the flowId to set |
| 343 | */ |
| 344 | public void setFlowId(FlowId flowId) { |
| 345 | this.flowId = flowId; |
| 346 | } |
Pavlin Radoslavov | 5363c2a | 2013-02-18 09:55:42 -0800 | [diff] [blame] | 347 | } |