3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
10 package org.opendaylight.controller.protocol_plugin.openflow.core.internal;
12 import java.io.IOException;
13 import java.nio.channels.SelectionKey;
14 import java.nio.channels.Selector;
15 import java.nio.channels.ServerSocketChannel;
16 import java.nio.channels.SocketChannel;
17 import java.util.Date;
18 import java.util.Iterator;
20 import java.util.Map.Entry;
22 import java.util.concurrent.BlockingQueue;
23 import java.util.concurrent.ConcurrentHashMap;
24 import java.util.concurrent.ConcurrentMap;
25 import java.util.concurrent.LinkedBlockingQueue;
26 import java.util.concurrent.atomic.AtomicInteger;
28 import org.eclipse.osgi.framework.console.CommandInterpreter;
29 import org.eclipse.osgi.framework.console.CommandProvider;
30 import org.opendaylight.controller.protocol_plugin.openflow.core.IController;
31 import org.opendaylight.controller.protocol_plugin.openflow.core.IMessageListener;
32 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitch;
33 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitchStateListener;
34 import org.openflow.protocol.OFMessage;
35 import org.openflow.protocol.OFType;
36 import org.openflow.util.HexString;
37 import org.osgi.framework.BundleContext;
38 import org.osgi.framework.FrameworkUtil;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
42 public class Controller implements IController, CommandProvider {
43 private static final Logger logger = LoggerFactory
44 .getLogger(Controller.class);
45 private ControllerIO controllerIO;
46 private Thread switchEventThread;
47 private ConcurrentHashMap<Long, ISwitch> switches;
48 private BlockingQueue<SwitchEvent> switchEvents;
49 // only 1 message listener per OFType
50 private ConcurrentMap<OFType, IMessageListener> messageListeners;
51 // only 1 switch state listener
52 private ISwitchStateListener switchStateListener;
53 private AtomicInteger switchInstanceNumber;
56 * this thread monitors the switchEvents queue for new incoming events from switch
58 private class EventHandler implements Runnable {
64 SwitchEvent ev = switchEvents.take();
65 SwitchEvent.SwitchEventType eType = ev.getEventType();
66 ISwitch sw = ev.getSwitch();
67 if (eType != SwitchEvent.SwitchEventType.SWITCH_MESSAGE) {
68 //logger.debug("Received " + ev.toString() + " from " + sw.toString());
72 Long sid = sw.getId();
73 ISwitch existingSwitch = switches.get(sid);
74 if (existingSwitch != null) {
75 logger.info(" Replacing existing "
76 + existingSwitch.toString() + " with New "
78 disconnectSwitch(existingSwitch);
80 switches.put(sid, sw);
81 notifySwitchAdded(sw);
90 OFMessage msg = ev.getMsg();
92 IMessageListener listener = messageListeners
94 if (listener != null) {
95 listener.receive(sw, msg);
100 logger.error("unknow switch event " + eType.ordinal());
102 } catch (InterruptedException e) {
103 switchEvents.clear();
112 * Function called by the dependency manager when all the required
113 * dependencies are satisfied
117 logger.debug("OpenFlowCore init");
118 this.switches = new ConcurrentHashMap<Long, ISwitch>();
119 this.switchEvents = new LinkedBlockingQueue<SwitchEvent>();
120 this.messageListeners = new ConcurrentHashMap<OFType, IMessageListener>();
121 this.switchStateListener = null;
122 this.switchInstanceNumber = new AtomicInteger(0);
123 registerWithOSGIConsole();
128 * Function called by dependency manager after "init ()" is called
129 * and after the services provided by the class are registered in
130 * the service registry
133 public void start() {
134 logger.debug("OpenFlowCore start() is called");
136 * start a thread to handle event coming from the switch
138 switchEventThread = new Thread(new EventHandler(), "SwitchEvent Thread");
139 switchEventThread.start();
141 // spawn a thread to start to listen on the open flow port
142 controllerIO = new ControllerIO(this);
144 controllerIO.start();
145 } catch (IOException ex) {
146 logger.error("Caught exception: " + ex + " during start");
151 * Function called by the dependency manager before the services
152 * exported by the component are unregistered, this will be
153 * followed by a "destroy ()" calls
158 for (Iterator<Entry<Long, ISwitch>> it = switches.entrySet().iterator(); it
160 Entry<Long, ISwitch> entry = it.next();
161 ((SwitchHandler) entry.getValue()).stop();
164 switchEventThread.interrupt();
165 controllerIO.shutDown();
169 * Function called by the dependency manager when at least one
170 * dependency become unsatisfied or when the component is shutting
171 * down because for example bundle is being stopped.
174 public void destroy() {
178 public void addMessageListener(OFType type, IMessageListener listener) {
179 IMessageListener currentListener = this.messageListeners.get(type);
180 if (currentListener != null) {
181 logger.warn(type.toString() + " already listened by "
182 + currentListener.toString());
184 this.messageListeners.put(type, listener);
185 logger.debug(type.toString() + " is now listened by "
186 + listener.toString());
190 public void removeMessageListener(OFType type, IMessageListener listener) {
191 IMessageListener currentListener = this.messageListeners.get(type);
192 if ((currentListener != null) && (currentListener == listener)) {
193 this.messageListeners.remove(type);
198 public void addSwitchStateListener(ISwitchStateListener listener) {
199 if (this.switchStateListener != null) {
200 logger.warn(this.switchStateListener.toString()
201 + "already listened to switch events");
203 this.switchStateListener = listener;
204 logger.debug(listener.toString() + " now listens to switch events");
208 public void removeSwitchStateListener(ISwitchStateListener listener) {
209 if ((this.switchStateListener != null)
210 && (this.switchStateListener == listener)) {
211 this.switchStateListener = null;
215 public void handleNewConnection(Selector selector,
216 SelectionKey serverSelectionKey) {
217 ServerSocketChannel ssc = (ServerSocketChannel) serverSelectionKey
219 SocketChannel sc = null;
223 int i = this.switchInstanceNumber.addAndGet(1);
224 String instanceName = "SwitchHandler-" + i;
225 SwitchHandler switchHandler = new SwitchHandler(this, sc,
227 switchHandler.start();
228 logger.info(instanceName + " connected: " + sc.toString());
229 } catch (IOException e) {
231 .error("Caught I/O Exception when trying to accept a new connection");
236 private void disconnectSwitch(ISwitch sw) {
237 if (((SwitchHandler) sw).isOperational()) {
238 Long sid = sw.getId();
239 if (this.switches.remove(sid, sw)) {
240 logger.warn(sw.toString() + " is disconnected");
241 notifySwitchDeleted(sw);
243 //logger.warn(sw.toString() + " has been replaced by " +
244 // this.switches.get(sid));
247 ((SwitchHandler) sw).stop();
250 private void notifySwitchAdded(ISwitch sw) {
251 if (switchStateListener != null) {
252 switchStateListener.switchAdded(sw);
256 private void notifySwitchDeleted(ISwitch sw) {
257 if (switchStateListener != null) {
258 switchStateListener.switchDeleted(sw);
262 private synchronized void addSwitchEvent(SwitchEvent event) {
264 this.switchEvents.put(event);
265 } catch (InterruptedException e) {
267 logger.error("Interrupt Exception " + e.toString());
271 public void takeSwtichEventAdd(ISwitch sw) {
272 SwitchEvent ev = new SwitchEvent(
273 SwitchEvent.SwitchEventType.SWITCH_ADD, sw, null);
277 public void takeSwitchEventDelete(ISwitch sw) {
278 SwitchEvent ev = new SwitchEvent(
279 SwitchEvent.SwitchEventType.SWITCH_DELETE, sw, null);
283 public void takeSwitchEventError(ISwitch sw) {
284 SwitchEvent ev = new SwitchEvent(
285 SwitchEvent.SwitchEventType.SWITCH_ERROR, sw, null);
289 public void takeSwitchEventMsg(ISwitch sw, OFMessage msg) {
290 if (messageListeners.get(msg.getType()) != null) {
291 SwitchEvent ev = new SwitchEvent(
292 SwitchEvent.SwitchEventType.SWITCH_MESSAGE, sw, msg);
298 public Map<Long, ISwitch> getSwitches() {
299 return this.switches;
303 public ISwitch getSwitch(Long switchId) {
304 return this.switches.get(switchId);
307 public void _controllerShowSwitches(CommandInterpreter ci) {
308 Set<Long> sids = switches.keySet();
309 StringBuffer s = new StringBuffer();
310 int size = sids.size();
312 ci.print("switches: empty");
315 Iterator<Long> iter = sids.iterator();
316 s.append("Total: " + size + " switches\n");
317 while (iter.hasNext()) {
318 Long sid = iter.next();
319 Date date = switches.get(sid).getConnectedDate();
320 String switchInstanceName = ((SwitchHandler) switches.get(sid)).getInstanceName();
321 s.append(switchInstanceName + "/" + HexString.toHexString(sid)
322 + " connected since " + date.toString() + "\n");
324 ci.print(s.toString());
328 public void _controllerReset(CommandInterpreter ci) {
329 ci.print("...Disconnecting the communication to all switches...\n");
333 } catch (InterruptedException ie) {
335 ci.print("...start to accept connections from switches...\n");
340 private void registerWithOSGIConsole() {
341 BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass())
343 bundleContext.registerService(CommandProvider.class.getName(), this,
348 public String getHelp() {
349 StringBuffer help = new StringBuffer();
350 help.append("--Open Flow Controller --\n");
351 help.append("\tcontrollerShowSwitches\n");
352 help.append("\tcontrollerReset\n");
353 return help.toString();