2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowplugin.openflow.md.core;
11 import java.util.Collection;
12 import java.util.List;
13 import java.util.concurrent.Future;
14 import java.util.concurrent.LinkedBlockingQueue;
15 import java.util.concurrent.TimeUnit;
17 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
18 import org.opendaylight.openflowplugin.openflow.core.IMessageListener;
19 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
20 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
21 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionManager;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoInputBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInputBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesInputBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloInputBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestMessage;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
41 import org.opendaylight.yangtools.yang.binding.DataObject;
42 import org.opendaylight.yangtools.yang.common.RpcError;
43 import org.opendaylight.yangtools.yang.common.RpcResult;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
47 import com.google.common.collect.ImmutableMap;
48 import com.google.common.collect.Lists;
53 public class ConnectionConductorImpl implements OpenflowProtocolListener,
54 SystemNotificationsListener, ConnectionConductor {
56 private static final Logger LOG = LoggerFactory
57 .getLogger(ConnectionConductorImpl.class);
59 private LinkedBlockingQueue<Exception> errorQueue = new LinkedBlockingQueue<>();
61 private final ConnectionAdapter connectionAdapter;
62 private final List<Short> versionOrder;
63 private ConnectionConductor.CONDUCTOR_STATE conductorState;
64 private Short version;
66 private SwitchConnectionDistinguisher auxiliaryKey;
68 private SessionContext sessionContext;
70 private ImmutableMap<Class<? extends DataObject>, Collection<IMDMessageListener>> listenerMapping;
73 * @param connectionAdapter
75 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
76 this.connectionAdapter = connectionAdapter;
77 conductorState = CONDUCTOR_STATE.HANDSHAKING;
78 versionOrder = Lists.newArrayList((short) 0x04, (short) 0x01);
79 new Thread(new ErrorQueueHandler(errorQueue)).start();
84 connectionAdapter.setMessageListener(this);
85 connectionAdapter.setSystemListener(this);
89 public void onEchoRequestMessage(EchoRequestMessage echoRequestMessage) {
90 LOG.debug("echo request received: " + echoRequestMessage.getXid());
91 EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
92 builder.setVersion(echoRequestMessage.getVersion());
93 builder.setXid(echoRequestMessage.getXid());
94 builder.setData(echoRequestMessage.getData());
96 connectionAdapter.echoReply(builder.build());
100 public void onErrorMessage(ErrorMessage errorMessage) {
101 // TODO Auto-generated method stub
102 LOG.debug("error received, type: " + errorMessage.getType()
103 + "; code: " + errorMessage.getCode());
107 public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
108 // TODO Auto-generated method stub
109 LOG.debug("experimenter received, type: "
110 + experimenterMessage.getExpType());
114 public void onFlowRemovedMessage(FlowRemovedMessage arg0) {
115 // TODO Auto-generated method stub
119 public void onHelloMessage(HelloMessage hello) {
121 LOG.info("handshake STARTED");
122 checkState(CONDUCTOR_STATE.HANDSHAKING);
124 Short remoteVersion = hello.getVersion();
125 long xid = hello.getXid();
126 short proposedVersion;
128 proposedVersion = proposeVersion(remoteVersion);
129 } catch (Exception e) {
133 HelloInputBuilder helloBuilder = new HelloInputBuilder();
135 helloBuilder.setVersion(proposedVersion).setXid(xid);
136 LOG.debug("sending helloReply");
137 connectionAdapter.hello(helloBuilder.build());
139 if (proposedVersion != remoteVersion) {
140 // need to wait for another hello
142 // sent version is equal to remote --> version is negotiated
143 version = proposedVersion;
144 LOG.debug("version set: " + proposedVersion);
147 GetFeaturesInputBuilder featuresBuilder = new GetFeaturesInputBuilder();
149 featuresBuilder.setVersion(version).setXid(xid);
150 Future<RpcResult<GetFeaturesOutput>> featuresFuture = connectionAdapter
151 .getFeatures(featuresBuilder.build());
152 LOG.debug("waiting for features");
153 RpcResult<GetFeaturesOutput> rpcFeatures;
155 rpcFeatures = featuresFuture.get(getMaxTimeout(),
156 TimeUnit.MILLISECONDS);
157 if (!rpcFeatures.isSuccessful()) {
158 LOG.error("obtained features problem: "
159 + rpcFeatures.getErrors());
161 LOG.debug("obtained features: datapathId="
162 + rpcFeatures.getResult().getDatapathId());
163 conductorState = CONDUCTOR_STATE.WORKING;
165 OFSessionUtil.registerSession(this,
166 rpcFeatures.getResult(), version);
167 LOG.info("handshake SETTLED");
169 } catch (Exception e) {
176 * @return rpc-response timeout in [ms]
178 private long getMaxTimeout() {
179 // TODO:: get from configuration
186 private void handleException(Exception e) {
189 } catch (InterruptedException e1) {
190 LOG.error(e1.getMessage(), e1);
195 public void onMultipartReplyMessage(MultipartReplyMessage arg0) {
196 // TODO Auto-generated method stub
200 public void onMultipartRequestMessage(MultipartRequestMessage arg0) {
201 // TODO Auto-generated method stub
205 public void onPacketInMessage(PacketInMessage message) {
206 notifyListeners(PacketInMessage.class, message);
210 public void onPortStatusMessage(PortStatusMessage arg0) {
211 // TODO Auto-generated method stub
215 public void onSwitchIdleEvent(SwitchIdleEvent notification) {
216 if (!CONDUCTOR_STATE.WORKING.equals(conductorState)) {
217 // idle state in any other conductorState than WORKING means real
218 // problem and wont be handled by echoReply, but disconnection
219 OFSessionUtil.getSessionManager().invalidateOnDisconnect(this);
221 LOG.debug("first idle state occured");
222 EchoInputBuilder builder = new EchoInputBuilder();
223 builder.setVersion(version);
224 // TODO: get xid from sessionContext
227 Future<RpcResult<EchoOutput>> echoReplyFuture = connectionAdapter
228 .echo(builder.build());
231 // TODO: read timeout from config
232 RpcResult<EchoOutput> echoReplyValue = echoReplyFuture.get(5,
234 if (echoReplyValue.isSuccessful()) {
235 conductorState = CONDUCTOR_STATE.WORKING;
237 for (RpcError replyError : echoReplyValue.getErrors()) {
238 Throwable cause = replyError.getCause();
240 "while receiving echoReply in TIMEOUTING state: "
241 + cause.getMessage(), cause);
244 } catch (Exception e) {
245 LOG.error("while waiting for echoReply in TIMEOUTING state: "
246 + e.getMessage(), e);
252 * @param conductorState
253 * the connectionState to set
256 public void setConductorState(CONDUCTOR_STATE conductorState) {
257 this.conductorState = conductorState;
261 public CONDUCTOR_STATE getConductorState() {
262 return conductorState;
268 private void checkState(CONDUCTOR_STATE expectedState) {
269 if (!conductorState.equals(expectedState)) {
270 throw new IllegalStateException("Expected state: " + expectedState
271 + ", actual state:" + conductorState);
276 public void onDisconnectEvent(DisconnectEvent arg0) {
277 SessionManager sessionManager = OFSessionUtil.getSessionManager();
278 sessionManager.invalidateOnDisconnect(this);
281 protected short proposeVersion(short remoteVersion) {
282 Short proposal = null;
283 for (short offer : versionOrder) {
284 if (offer <= remoteVersion) {
289 if (proposal == null) {
290 throw new IllegalArgumentException("unsupported version: "
297 public Short getVersion() {
302 public Future<Boolean> disconnect() {
303 return connectionAdapter.disconnect();
307 public void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey) {
308 this.auxiliaryKey = auxiliaryKey;
312 public void setSessionContext(SessionContext sessionContext) {
313 this.sessionContext = sessionContext;
317 public SwitchConnectionDistinguisher getAuxiliaryKey() {
322 public SessionContext getSessionContext() {
323 return sessionContext;
327 * @param listenerMapping the listenerMapping to set
329 public void setListenerMapping(
330 ImmutableMap<Class<? extends DataObject>, Collection<IMDMessageListener>> listenerMapping) {
331 //TODO: adjust the listener interface
332 this.listenerMapping = listenerMapping;
339 private void notifyListeners(Class<? extends DataObject> messageType, DataObject message) {
340 Collection<IMDMessageListener> listeners = listenerMapping.get(messageType);
341 if (listeners != null) {
342 for (IMDMessageListener listener : listeners) {
343 //TODO : need to add unit-tests
344 //listener.receive(this.getAuxiliaryKey(), this.getSessionContext(), message);