Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -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 |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -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 | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 16 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 17 | package org.onosproject.openflow.controller.driver; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 18 | |
| 19 | import java.io.IOException; |
Ray Milkey | e53f171 | 2015-01-16 09:17:16 -0800 | [diff] [blame] | 20 | import java.net.InetSocketAddress; |
| 21 | import java.net.SocketAddress; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 22 | import java.util.Collections; |
| 23 | import java.util.List; |
Thomas Vachuska | f15511b | 2015-03-24 12:17:57 -0700 | [diff] [blame] | 24 | import java.util.concurrent.RejectedExecutionException; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 25 | import java.util.concurrent.atomic.AtomicInteger; |
| 26 | |
| 27 | import org.jboss.netty.channel.Channel; |
Ray Milkey | e53f171 | 2015-01-16 09:17:16 -0800 | [diff] [blame] | 28 | import org.onlab.packet.IpAddress; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 29 | import org.onosproject.openflow.controller.Dpid; |
| 30 | import org.onosproject.openflow.controller.RoleState; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 31 | import org.projectfloodlight.openflow.protocol.OFDescStatsReply; |
| 32 | import org.projectfloodlight.openflow.protocol.OFErrorMsg; |
| 33 | import org.projectfloodlight.openflow.protocol.OFExperimenter; |
| 34 | import org.projectfloodlight.openflow.protocol.OFFactories; |
| 35 | import org.projectfloodlight.openflow.protocol.OFFactory; |
| 36 | import org.projectfloodlight.openflow.protocol.OFFeaturesReply; |
| 37 | import org.projectfloodlight.openflow.protocol.OFMessage; |
| 38 | import org.projectfloodlight.openflow.protocol.OFPortDesc; |
| 39 | import org.projectfloodlight.openflow.protocol.OFPortDescStatsReply; |
Thomas Vachuska | 3927446 | 2014-12-02 13:23:50 -0800 | [diff] [blame] | 40 | import org.projectfloodlight.openflow.protocol.OFPortStatus; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 41 | import org.projectfloodlight.openflow.protocol.OFRoleReply; |
| 42 | import org.projectfloodlight.openflow.protocol.OFVersion; |
| 43 | import org.slf4j.Logger; |
| 44 | import org.slf4j.LoggerFactory; |
| 45 | |
| 46 | /** |
| 47 | * An abstract representation of an OpenFlow switch. Can be extended by others |
| 48 | * to serve as a base for their vendor specific representation of a switch. |
| 49 | */ |
| 50 | public abstract class AbstractOpenFlowSwitch implements OpenFlowSwitchDriver { |
| 51 | |
Yuta HIGUCHI | f5416d8 | 2014-10-24 21:17:40 -0700 | [diff] [blame] | 52 | protected final Logger log = LoggerFactory.getLogger(getClass()); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 53 | |
Thomas Vachuska | f15511b | 2015-03-24 12:17:57 -0700 | [diff] [blame] | 54 | private static final String SHUTDOWN_MSG = "Worker has already been shutdown"; |
| 55 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 56 | protected Channel channel; |
Ray Milkey | e53f171 | 2015-01-16 09:17:16 -0800 | [diff] [blame] | 57 | protected String channelId; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 58 | |
| 59 | private boolean connected; |
| 60 | protected boolean startDriverHandshakeCalled = false; |
| 61 | private final Dpid dpid; |
| 62 | private OpenFlowAgent agent; |
| 63 | private final AtomicInteger xidCounter = new AtomicInteger(0); |
| 64 | |
| 65 | private OFVersion ofVersion; |
| 66 | |
| 67 | protected OFPortDescStatsReply ports; |
| 68 | |
| 69 | protected boolean tableFull; |
| 70 | |
| 71 | private RoleHandler roleMan; |
| 72 | |
| 73 | protected RoleState role; |
| 74 | |
| 75 | protected OFFeaturesReply features; |
| 76 | protected OFDescStatsReply desc; |
| 77 | |
| 78 | /** |
| 79 | * Given a dpid build this switch. |
| 80 | * @param dp the dpid |
| 81 | */ |
| 82 | protected AbstractOpenFlowSwitch(Dpid dp) { |
| 83 | this.dpid = dp; |
| 84 | } |
| 85 | |
| 86 | public AbstractOpenFlowSwitch(Dpid dpid, OFDescStatsReply desc) { |
| 87 | this.dpid = dpid; |
| 88 | this.desc = desc; |
| 89 | } |
| 90 | |
| 91 | //************************ |
| 92 | // Channel related |
| 93 | //************************ |
| 94 | |
| 95 | @Override |
| 96 | public final void disconnectSwitch() { |
| 97 | this.channel.close(); |
| 98 | } |
| 99 | |
| 100 | @Override |
| 101 | public final void sendMsg(OFMessage m) { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 102 | if (role == RoleState.MASTER) { |
Thomas Vachuska | f15511b | 2015-03-24 12:17:57 -0700 | [diff] [blame] | 103 | try { |
| 104 | this.write(m); |
| 105 | } catch (RejectedExecutionException e) { |
| 106 | if (!e.getMessage().contains(SHUTDOWN_MSG)) { |
| 107 | throw e; |
| 108 | } |
| 109 | } |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 110 | } |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | @Override |
| 114 | public final void sendMsg(List<OFMessage> msgs) { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 115 | if (role == RoleState.MASTER) { |
Thomas Vachuska | f15511b | 2015-03-24 12:17:57 -0700 | [diff] [blame] | 116 | try { |
| 117 | this.write(msgs); |
| 118 | } catch (RejectedExecutionException e) { |
| 119 | if (!e.getMessage().contains(SHUTDOWN_MSG)) { |
| 120 | throw e; |
| 121 | } |
| 122 | } |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 123 | } |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | @Override |
| 127 | public abstract void write(OFMessage msg); |
| 128 | |
| 129 | @Override |
| 130 | public abstract void write(List<OFMessage> msgs); |
| 131 | |
| 132 | @Override |
| 133 | public final boolean isConnected() { |
| 134 | return this.connected; |
| 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public final void setConnected(boolean connected) { |
| 139 | this.connected = connected; |
| 140 | }; |
| 141 | |
| 142 | @Override |
| 143 | public final void setChannel(Channel channel) { |
| 144 | this.channel = channel; |
Ray Milkey | e53f171 | 2015-01-16 09:17:16 -0800 | [diff] [blame] | 145 | final SocketAddress address = channel.getRemoteAddress(); |
| 146 | if (address instanceof InetSocketAddress) { |
| 147 | final InetSocketAddress inetAddress = (InetSocketAddress) address; |
| 148 | final IpAddress ipAddress = IpAddress.valueOf(inetAddress.getAddress()); |
Pavlin Radoslavov | 87dd930 | 2015-03-10 13:53:24 -0700 | [diff] [blame] | 149 | if (ipAddress.isIp4()) { |
Ray Milkey | e53f171 | 2015-01-16 09:17:16 -0800 | [diff] [blame] | 150 | channelId = ipAddress.toString() + ':' + inetAddress.getPort(); |
| 151 | } else { |
| 152 | channelId = '[' + ipAddress.toString() + "]:" + inetAddress.getPort(); |
| 153 | } |
| 154 | } |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 155 | }; |
| 156 | |
Ray Milkey | e53f171 | 2015-01-16 09:17:16 -0800 | [diff] [blame] | 157 | @Override |
| 158 | public String channelId() { |
| 159 | return channelId; |
| 160 | } |
| 161 | |
| 162 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 163 | //************************ |
| 164 | // Switch features related |
| 165 | //************************ |
| 166 | |
| 167 | @Override |
| 168 | public final long getId() { |
| 169 | return this.dpid.value(); |
| 170 | }; |
| 171 | |
| 172 | @Override |
| 173 | public final String getStringId() { |
| 174 | return this.dpid.toString(); |
| 175 | } |
| 176 | |
| 177 | @Override |
| 178 | public final void setOFVersion(OFVersion ofV) { |
| 179 | this.ofVersion = ofV; |
| 180 | } |
| 181 | |
| 182 | @Override |
| 183 | public void setTableFull(boolean full) { |
| 184 | this.tableFull = full; |
| 185 | } |
| 186 | |
| 187 | @Override |
| 188 | public void setFeaturesReply(OFFeaturesReply featuresReply) { |
| 189 | this.features = featuresReply; |
| 190 | } |
| 191 | |
| 192 | @Override |
| 193 | public abstract Boolean supportNxRole(); |
| 194 | |
| 195 | //************************ |
| 196 | // Message handling |
| 197 | //************************ |
| 198 | /** |
| 199 | * Handle the message coming from the dataplane. |
| 200 | * |
| 201 | * @param m the actual message |
| 202 | */ |
| 203 | @Override |
| 204 | public final void handleMessage(OFMessage m) { |
Thomas Vachuska | 3927446 | 2014-12-02 13:23:50 -0800 | [diff] [blame] | 205 | if (this.role == RoleState.MASTER || m instanceof OFPortStatus) { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 206 | this.agent.processMessage(dpid, m); |
| 207 | } |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | @Override |
| 211 | public RoleState getRole() { |
| 212 | return role; |
| 213 | }; |
| 214 | |
| 215 | @Override |
| 216 | public final boolean connectSwitch() { |
| 217 | return this.agent.addConnectedSwitch(dpid, this); |
| 218 | } |
| 219 | |
| 220 | @Override |
| 221 | public final boolean activateMasterSwitch() { |
| 222 | return this.agent.addActivatedMasterSwitch(dpid, this); |
| 223 | } |
| 224 | |
| 225 | @Override |
| 226 | public final boolean activateEqualSwitch() { |
| 227 | return this.agent.addActivatedEqualSwitch(dpid, this); |
| 228 | } |
| 229 | |
| 230 | @Override |
| 231 | public final void transitionToEqualSwitch() { |
| 232 | this.agent.transitionToEqualSwitch(dpid); |
| 233 | } |
| 234 | |
| 235 | @Override |
| 236 | public final void transitionToMasterSwitch() { |
| 237 | this.agent.transitionToMasterSwitch(dpid); |
| 238 | } |
| 239 | |
| 240 | @Override |
| 241 | public final void removeConnectedSwitch() { |
| 242 | this.agent.removeConnectedSwitch(dpid); |
| 243 | } |
| 244 | |
| 245 | @Override |
| 246 | public OFFactory factory() { |
| 247 | return OFFactories.getFactory(ofVersion); |
| 248 | } |
| 249 | |
| 250 | @Override |
| 251 | public void setPortDescReply(OFPortDescStatsReply portDescReply) { |
| 252 | this.ports = portDescReply; |
| 253 | } |
| 254 | |
| 255 | @Override |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 256 | public void returnRoleReply(RoleState requested, RoleState response) { |
| 257 | this.agent.returnRoleReply(dpid, requested, response); |
Ayaka Koshibe | ab91cc4 | 2014-09-25 10:20:52 -0700 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | @Override |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 261 | public abstract void startDriverHandshake(); |
| 262 | |
| 263 | @Override |
| 264 | public abstract boolean isDriverHandshakeComplete(); |
| 265 | |
| 266 | @Override |
| 267 | public abstract void processDriverHandshakeMessage(OFMessage m); |
| 268 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 269 | |
| 270 | // Role Handling |
| 271 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 272 | @Override |
| 273 | public void setRole(RoleState role) { |
| 274 | try { |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 275 | if (this.roleMan.sendRoleRequest(role, RoleRecvStatus.MATCHED_SET_ROLE)) { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 276 | log.info("Sending role {} to switch {}", role, getStringId()); |
| 277 | if (role == RoleState.SLAVE || role == RoleState.EQUAL) { |
| 278 | this.role = role; |
| 279 | } |
alshabib | 7814e9f | 2014-09-30 11:52:12 -0700 | [diff] [blame] | 280 | } else { |
| 281 | this.role = role; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 282 | } |
| 283 | } catch (IOException e) { |
| 284 | log.error("Unable to write to switch {}.", this.dpid); |
| 285 | } |
| 286 | } |
| 287 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 288 | @Override |
| 289 | public void reassertRole() { |
| 290 | if (this.getRole() == RoleState.MASTER) { |
| 291 | log.warn("Received permission error from switch {} while " + |
| 292 | "being master. Reasserting master role.", |
| 293 | this.getStringId()); |
| 294 | this.setRole(RoleState.MASTER); |
| 295 | } |
| 296 | } |
| 297 | |
| 298 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 299 | |
| 300 | @Override |
| 301 | public void handleRole(OFMessage m) throws SwitchStateException { |
| 302 | RoleReplyInfo rri = roleMan.extractOFRoleReply((OFRoleReply) m); |
| 303 | RoleRecvStatus rrs = roleMan.deliverRoleReply(rri); |
| 304 | if (rrs == RoleRecvStatus.MATCHED_SET_ROLE) { |
| 305 | if (rri.getRole() == RoleState.MASTER) { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 306 | this.role = rri.getRole(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 307 | this.transitionToMasterSwitch(); |
| 308 | } else if (rri.getRole() == RoleState.EQUAL || |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 309 | rri.getRole() == RoleState.SLAVE) { |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 310 | this.transitionToEqualSwitch(); |
| 311 | } |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 312 | } else { |
alshabib | 4785eec | 2014-12-04 16:45:45 -0800 | [diff] [blame] | 313 | log.warn("Failed to set role for {}", this.getStringId()); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 314 | } |
| 315 | } |
| 316 | |
| 317 | @Override |
| 318 | public void handleNiciraRole(OFMessage m) throws SwitchStateException { |
| 319 | RoleState r = this.roleMan.extractNiciraRoleReply((OFExperimenter) m); |
| 320 | if (r == null) { |
| 321 | // The message wasn't really a Nicira role reply. We just |
| 322 | // dispatch it to the OFMessage listeners in this case. |
| 323 | this.handleMessage(m); |
alshabib | dfc7afb | 2014-10-21 20:13:27 -0700 | [diff] [blame] | 324 | return; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 325 | } |
| 326 | |
| 327 | RoleRecvStatus rrs = this.roleMan.deliverRoleReply( |
| 328 | new RoleReplyInfo(r, null, m.getXid())); |
| 329 | if (rrs == RoleRecvStatus.MATCHED_SET_ROLE) { |
| 330 | if (r == RoleState.MASTER) { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 331 | this.role = r; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 332 | this.transitionToMasterSwitch(); |
| 333 | } else if (r == RoleState.EQUAL || |
| 334 | r == RoleState.SLAVE) { |
| 335 | this.transitionToEqualSwitch(); |
| 336 | } |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 337 | } else { |
alshabib | dfc7afb | 2014-10-21 20:13:27 -0700 | [diff] [blame] | 338 | this.disconnectSwitch(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 339 | } |
| 340 | } |
| 341 | |
| 342 | @Override |
| 343 | public boolean handleRoleError(OFErrorMsg error) { |
| 344 | try { |
| 345 | return RoleRecvStatus.OTHER_EXPECTATION != this.roleMan.deliverError(error); |
| 346 | } catch (SwitchStateException e) { |
| 347 | this.disconnectSwitch(); |
| 348 | } |
| 349 | return true; |
| 350 | } |
| 351 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 352 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 353 | |
| 354 | @Override |
| 355 | public final void setAgent(OpenFlowAgent ag) { |
| 356 | if (this.agent == null) { |
| 357 | this.agent = ag; |
| 358 | } |
| 359 | } |
| 360 | |
| 361 | @Override |
| 362 | public final void setRoleHandler(RoleHandler roleHandler) { |
| 363 | if (this.roleMan == null) { |
| 364 | this.roleMan = roleHandler; |
| 365 | } |
| 366 | } |
| 367 | |
| 368 | @Override |
| 369 | public void setSwitchDescription(OFDescStatsReply d) { |
| 370 | this.desc = d; |
| 371 | } |
| 372 | |
| 373 | @Override |
| 374 | public int getNextTransactionId() { |
| 375 | return this.xidCounter.getAndIncrement(); |
| 376 | } |
| 377 | |
| 378 | @Override |
| 379 | public List<OFPortDesc> getPorts() { |
| 380 | return Collections.unmodifiableList(ports.getEntries()); |
| 381 | } |
| 382 | |
| 383 | @Override |
Ray Milkey | d3edd03 | 2015-01-16 11:38:58 -0800 | [diff] [blame] | 384 | public String manufacturerDescription() { |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 385 | return this.desc.getMfrDesc(); |
| 386 | } |
| 387 | |
| 388 | |
| 389 | @Override |
| 390 | public String datapathDescription() { |
| 391 | return this.desc.getDpDesc(); |
| 392 | } |
| 393 | |
| 394 | |
| 395 | @Override |
| 396 | public String hardwareDescription() { |
| 397 | return this.desc.getHwDesc(); |
| 398 | } |
| 399 | |
| 400 | @Override |
| 401 | public String softwareDescription() { |
| 402 | return this.desc.getSwDesc(); |
| 403 | } |
| 404 | |
| 405 | @Override |
| 406 | public String serialNumber() { |
| 407 | return this.desc.getSerialNum(); |
| 408 | } |
| 409 | |
Praseed Balakrishnan | a22eadf | 2014-10-20 14:21:45 -0700 | [diff] [blame] | 410 | @Override |
| 411 | public boolean isOptical() { |
| 412 | return false; |
| 413 | } |
| 414 | |
alshabib | 9af7007 | 2015-02-09 14:34:16 -0800 | [diff] [blame] | 415 | |
| 416 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 417 | } |