Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame^] | 2 | * Copyright 2017-present Open Networking Foundation |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 3 | * |
| 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 |
| 7 | * |
| 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. |
| 15 | */ |
| 16 | package org.onosproject.ofagent.impl; |
| 17 | |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 18 | import io.netty.channel.Channel; |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 19 | import io.netty.channel.ChannelDuplexHandler; |
| 20 | import io.netty.channel.ChannelHandlerContext; |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 21 | import io.netty.handler.timeout.ReadTimeoutException; |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 22 | import org.onosproject.ofagent.api.OFSwitch; |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 23 | import org.projectfloodlight.openflow.protocol.OFErrorMsg; |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 24 | import org.projectfloodlight.openflow.protocol.OFMessage; |
| 25 | import org.slf4j.Logger; |
| 26 | import org.slf4j.LoggerFactory; |
| 27 | |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 28 | import java.io.IOException; |
| 29 | import java.nio.channels.ClosedChannelException; |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 30 | import java.util.concurrent.RejectedExecutionException; |
| 31 | |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 32 | import static org.onosproject.ofagent.impl.OFChannelHandler.ChannelState.INIT; |
| 33 | |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 34 | /** |
| 35 | * Implementation of OpenFlow channel handler. |
| 36 | * It processes OpenFlow message according to the channel state. |
| 37 | */ |
| 38 | public final class OFChannelHandler extends ChannelDuplexHandler { |
| 39 | |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 40 | private static final String MSG_CHANNEL_STATE = "Set channel(%s) state: %s"; |
| 41 | |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 42 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 43 | private final OFSwitch ofSwitch; |
| 44 | |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 45 | private Channel channel; |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 46 | private ChannelState state; |
| 47 | |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 48 | enum ChannelState { |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 49 | |
| 50 | INIT { |
| 51 | @Override |
| 52 | void processOFMessage(final OFChannelHandler handler, |
| 53 | final OFMessage msg) { |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 54 | logProcessOFMessageDetails(handler, msg, this); |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 55 | // TODO implement |
| 56 | } |
| 57 | }, |
| 58 | WAIT_HELLO { |
| 59 | @Override |
| 60 | void processOFMessage(final OFChannelHandler handler, |
| 61 | final OFMessage msg) { |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 62 | logProcessOFMessageDetails(handler, msg, this); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 63 | switch (msg.getType()) { |
| 64 | case HELLO: |
| 65 | handler.setState(ChannelState.WAIT_FEATURE_REQUEST); |
| 66 | break; |
| 67 | default: |
| 68 | handler.illegalMessageReceived(msg); |
| 69 | break; |
| 70 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 71 | } |
| 72 | }, |
| 73 | WAIT_FEATURE_REQUEST { |
| 74 | @Override |
| 75 | void processOFMessage(final OFChannelHandler handler, |
| 76 | final OFMessage msg) { |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 77 | logProcessOFMessageDetails(handler, msg, this); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 78 | switch (msg.getType()) { |
| 79 | case FEATURES_REQUEST: |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 80 | handler.ofSwitch.processFeaturesRequest(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 81 | handler.setState(ChannelState.ESTABLISHED); |
| 82 | break; |
| 83 | case ECHO_REQUEST: |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 84 | handler.ofSwitch.processEchoRequest(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 85 | break; |
| 86 | case ERROR: |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 87 | handler.logErrorClose((OFErrorMsg) msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 88 | break; |
| 89 | default: |
| 90 | handler.illegalMessageReceived(msg); |
| 91 | break; |
| 92 | |
| 93 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 94 | } |
| 95 | }, |
| 96 | ESTABLISHED { |
| 97 | @Override |
| 98 | void processOFMessage(final OFChannelHandler handler, |
| 99 | final OFMessage msg) { |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 100 | logProcessOFMessageDetails(handler, msg, this); |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 101 | // TODO implement |
| 102 | // TODO add this channel to ofSwitch role service |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 103 | switch (msg.getType()) { |
| 104 | case STATS_REQUEST: |
| 105 | //TODO implement |
| 106 | //TODO: use vNetService to build OFPortDesc. |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 107 | handler.ofSwitch.processStatsRequest(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 108 | break; |
| 109 | case SET_CONFIG: |
| 110 | //TODO implement |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 111 | handler.ofSwitch.processSetConfigMessage(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 112 | break; |
| 113 | case GET_CONFIG_REQUEST: |
| 114 | //TODO implement |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 115 | handler.ofSwitch.processGetConfigRequest(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 116 | break; |
| 117 | case BARRIER_REQUEST: |
| 118 | //TODO implement |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 119 | handler.ofSwitch.processBarrierRequest(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 120 | break; |
| 121 | case ECHO_REQUEST: |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 122 | handler.ofSwitch.processEchoRequest(handler.channel, msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 123 | break; |
Claudine Chiu | 7c6d51c | 2017-06-15 23:13:51 -0400 | [diff] [blame] | 124 | case ROLE_REQUEST: |
| 125 | handler.ofSwitch.processRoleRequest(handler.channel, msg); |
| 126 | break; |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 127 | case ERROR: |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 128 | handler.logErrorClose((OFErrorMsg) msg); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 129 | break; |
| 130 | default: |
| 131 | handler.unhandledMessageReceived(msg); |
| 132 | break; |
| 133 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 134 | } |
| 135 | }; |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 136 | |
| 137 | abstract void processOFMessage(final OFChannelHandler handler, final OFMessage msg); |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 138 | |
| 139 | private static void logProcessOFMessageDetails(final OFChannelHandler handler, |
| 140 | final OFMessage msg, ChannelState chnState) { |
| 141 | handler.log.trace("Channel state: {} dpid: {} processOFMessage type: {} nsg: {}", |
| 142 | chnState, handler.ofSwitch.dpid(), msg.getType(), msg); |
| 143 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Default constructor. |
| 148 | * |
| 149 | * @param ofSwitch openflow switch that owns this channel |
| 150 | */ |
| 151 | public OFChannelHandler(OFSwitch ofSwitch) { |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 152 | super(); |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 153 | this.ofSwitch = ofSwitch; |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 154 | setState(INIT); |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | @Override |
| 158 | public void channelActive(ChannelHandlerContext ctx) throws Exception { |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 159 | this.channel = ctx.channel(); |
| 160 | // FIXME move this to channel handler and add channel when OF handshake is done |
| 161 | ofSwitch.addControllerChannel(channel); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 162 | try { |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 163 | ofSwitch.sendOfHello(channel); |
| 164 | log.trace("Send OF_13 Hello to {}", channel.remoteAddress()); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 165 | setState(ChannelState.WAIT_HELLO); |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 166 | } catch (Exception ex) { |
| 167 | log.error("Failed sending OF_13 Hello to {} for {}", channel.remoteAddress(), ex.getMessage()); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 168 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | @Override |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 172 | public void channelInactive(ChannelHandlerContext ctx) { |
| 173 | ofSwitch.deleteControllerChannel(channel); |
| 174 | log.info("Device {} disconnected from controller {}", ofSwitch.dpid(), channel.remoteAddress()); |
| 175 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 176 | |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 177 | @Override |
| 178 | public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 179 | try { |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 180 | state.processOFMessage(this, (OFMessage) msg); |
| 181 | } catch (Exception ex) { |
| 182 | ctx.fireExceptionCaught(ex); |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 183 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | @Override |
| 187 | public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 188 | if (cause instanceof ReadTimeoutException) { |
| 189 | log.error("Connection closed because of ReadTimeoutException {}", cause.getMessage()); |
| 190 | } else if (cause instanceof ClosedChannelException) { |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 191 | log.error("ClosedChannelException occurred"); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 192 | return; |
| 193 | } else if (cause instanceof RejectedExecutionException) { |
| 194 | log.error("Could not process message: queue full"); |
| 195 | } else if (cause instanceof IOException) { |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 196 | log.error("IOException occurred"); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 197 | } else { |
| 198 | log.error("Error while processing message from switch {}", cause.getMessage()); |
| 199 | } |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 200 | channel.close(); |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | private void setState(ChannelState state) { |
| 204 | this.state = state; |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 205 | if (state != INIT) { |
| 206 | log.debug(String.format(MSG_CHANNEL_STATE, channel.remoteAddress(), state.name())); |
| 207 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 208 | } |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 209 | |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 210 | private void logErrorClose(OFErrorMsg errorMsg) { |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 211 | log.error("{} from switch {} in state {}", |
| 212 | errorMsg, |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 213 | ofSwitch.dpid(), |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 214 | state); |
Hyunsun Moon | f4ba44f | 2017-03-14 03:25:52 +0900 | [diff] [blame] | 215 | channel.close(); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 216 | } |
| 217 | |
| 218 | private void illegalMessageReceived(OFMessage ofMessage) { |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 219 | log.warn("Controller should never send message {} to switch {} in current state {}", |
| 220 | ofMessage.getType(), ofSwitch.dpid(), state); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | private void unhandledMessageReceived(OFMessage ofMessage) { |
Claudine Chiu | e2d5acc | 2017-06-08 22:49:21 -0400 | [diff] [blame] | 224 | log.warn("Unexpected message {} received for switch {} in state {}", |
| 225 | ofMessage.getType(), ofSwitch.dpid(), state); |
Daniel Park | be6b673 | 2016-11-11 15:52:19 +0900 | [diff] [blame] | 226 | } |
Hyunsun Moon | 90163ba | 2016-10-12 13:35:14 -0700 | [diff] [blame] | 227 | } |