Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 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.impl; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 18 | |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 19 | import com.google.common.base.Strings; |
| 20 | import com.google.common.collect.ImmutableList; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 21 | import org.jboss.netty.bootstrap.ServerBootstrap; |
| 22 | import org.jboss.netty.channel.ChannelPipelineFactory; |
| 23 | import org.jboss.netty.channel.group.ChannelGroup; |
| 24 | import org.jboss.netty.channel.group.DefaultChannelGroup; |
| 25 | import org.jboss.netty.channel.socket.nio.NioServerSocketChannelFactory; |
Jonathan Hart | a0d1249 | 2015-07-16 12:03:41 -0700 | [diff] [blame] | 26 | import org.onlab.util.ItemNotFoundException; |
| 27 | import org.onosproject.net.DeviceId; |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 28 | import org.onosproject.net.driver.DefaultDriverData; |
| 29 | import org.onosproject.net.driver.DefaultDriverHandler; |
| 30 | import org.onosproject.net.driver.Driver; |
| 31 | import org.onosproject.net.driver.DriverService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 32 | import org.onosproject.openflow.controller.Dpid; |
| 33 | import org.onosproject.openflow.controller.driver.OpenFlowAgent; |
| 34 | import org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 35 | import org.projectfloodlight.openflow.protocol.OFDescStatsReply; |
| 36 | import org.projectfloodlight.openflow.protocol.OFFactories; |
| 37 | import org.projectfloodlight.openflow.protocol.OFFactory; |
| 38 | import org.projectfloodlight.openflow.protocol.OFVersion; |
| 39 | import org.slf4j.Logger; |
| 40 | import org.slf4j.LoggerFactory; |
| 41 | |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 42 | import java.lang.management.ManagementFactory; |
| 43 | import java.lang.management.RuntimeMXBean; |
| 44 | import java.net.InetSocketAddress; |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 45 | import java.util.Dictionary; |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 46 | import java.util.HashMap; |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 47 | import java.util.List; |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 48 | import java.util.Map; |
| 49 | import java.util.concurrent.Executors; |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 50 | import java.util.stream.Collectors; |
| 51 | import java.util.stream.Stream; |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 52 | |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 53 | import static org.onlab.util.Tools.get; |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 54 | import static org.onlab.util.Tools.groupedThreads; |
Thomas Vachuska | 80b0a80 | 2015-07-17 08:43:30 -0700 | [diff] [blame] | 55 | import static org.onosproject.net.DeviceId.deviceId; |
| 56 | import static org.onosproject.openflow.controller.Dpid.uri; |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 57 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * The main controller class. Handles all setup and network listeners |
| 61 | * - Distributed ownership control of switch through IControllerRegistryService |
| 62 | */ |
| 63 | public class Controller { |
| 64 | |
| 65 | protected static final Logger log = LoggerFactory.getLogger(Controller.class); |
alshabib | 9eab22f | 2014-10-20 17:17:31 -0700 | [diff] [blame] | 66 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 67 | protected static final OFFactory FACTORY13 = OFFactories.getFactory(OFVersion.OF_13); |
| 68 | protected static final OFFactory FACTORY10 = OFFactories.getFactory(OFVersion.OF_10); |
| 69 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 70 | protected HashMap<String, String> controllerNodeIPsCache; |
| 71 | |
| 72 | private ChannelGroup cg; |
| 73 | |
| 74 | // Configuration options |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 75 | protected List<Integer> openFlowPorts = ImmutableList.of(6633, 6653); |
| 76 | protected int workerThreads = 16; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 77 | |
| 78 | // Start time of the controller |
| 79 | protected long systemStartTime; |
| 80 | |
| 81 | private OpenFlowAgent agent; |
| 82 | |
| 83 | private NioServerSocketChannelFactory execFactory; |
| 84 | |
| 85 | // Perf. related configuration |
| 86 | protected static final int SEND_BUFFER_SIZE = 4 * 1024 * 1024; |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 87 | private DriverService driverService; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 88 | |
| 89 | // *************** |
| 90 | // Getters/Setters |
| 91 | // *************** |
| 92 | |
| 93 | public OFFactory getOFMessageFactory10() { |
| 94 | return FACTORY10; |
| 95 | } |
| 96 | |
| 97 | |
| 98 | public OFFactory getOFMessageFactory13() { |
| 99 | return FACTORY13; |
| 100 | } |
| 101 | |
| 102 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 103 | public Map<String, String> getControllerNodeIPs() { |
| 104 | // We return a copy of the mapping so we can guarantee that |
| 105 | // the mapping return is the same as one that will be (or was) |
| 106 | // dispatched to IHAListeners |
Jonathan Hart | bbd91d4 | 2015-02-27 11:18:04 -0800 | [diff] [blame] | 107 | HashMap<String, String> retval = new HashMap<>(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 108 | synchronized (controllerNodeIPsCache) { |
| 109 | retval.putAll(controllerNodeIPsCache); |
| 110 | } |
| 111 | return retval; |
| 112 | } |
| 113 | |
| 114 | |
| 115 | public long getSystemStartTime() { |
| 116 | return (this.systemStartTime); |
| 117 | } |
| 118 | |
| 119 | // ************** |
| 120 | // Initialization |
| 121 | // ************** |
| 122 | |
| 123 | /** |
| 124 | * Tell controller that we're ready to accept switches loop. |
| 125 | */ |
| 126 | public void run() { |
| 127 | |
| 128 | try { |
| 129 | final ServerBootstrap bootstrap = createServerBootStrap(); |
| 130 | |
| 131 | bootstrap.setOption("reuseAddr", true); |
| 132 | bootstrap.setOption("child.keepAlive", true); |
| 133 | bootstrap.setOption("child.tcpNoDelay", true); |
| 134 | bootstrap.setOption("child.sendBufferSize", Controller.SEND_BUFFER_SIZE); |
| 135 | |
| 136 | ChannelPipelineFactory pfact = |
| 137 | new OpenflowPipelineFactory(this, null); |
| 138 | bootstrap.setPipelineFactory(pfact); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 139 | cg = new DefaultChannelGroup(); |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 140 | openFlowPorts.forEach(port -> { |
| 141 | InetSocketAddress sa = new InetSocketAddress(port); |
| 142 | cg.add(bootstrap.bind(sa)); |
| 143 | log.info("Listening for switch connections on {}", sa); |
| 144 | }); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 145 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 146 | } catch (Exception e) { |
| 147 | throw new RuntimeException(e); |
| 148 | } |
| 149 | |
| 150 | } |
| 151 | |
| 152 | private ServerBootstrap createServerBootStrap() { |
| 153 | |
| 154 | if (workerThreads == 0) { |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 155 | execFactory = new NioServerSocketChannelFactory( |
| 156 | Executors.newCachedThreadPool(groupedThreads("onos/of", "boss-%d")), |
| 157 | Executors.newCachedThreadPool(groupedThreads("onos/of", "worker-%d"))); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 158 | return new ServerBootstrap(execFactory); |
| 159 | } else { |
| 160 | execFactory = new NioServerSocketChannelFactory( |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 161 | Executors.newCachedThreadPool(groupedThreads("onos/of", "boss-%d")), |
| 162 | Executors.newCachedThreadPool(groupedThreads("onos/of", "worker-%d")), workerThreads); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 163 | return new ServerBootstrap(execFactory); |
| 164 | } |
| 165 | } |
| 166 | |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 167 | public void setConfigParams(Dictionary<?, ?> properties) { |
| 168 | String ports = get(properties, "openflowPorts"); |
| 169 | if (!Strings.isNullOrEmpty(ports)) { |
| 170 | this.openFlowPorts = Stream.of(ports.split(",")) |
| 171 | .map(s -> Integer.parseInt(s)) |
| 172 | .collect(Collectors.toList()); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 173 | } |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 174 | log.debug("OpenFlow ports set to {}", this.openFlowPorts); |
Charles Chan | 45624b8 | 2015-08-24 00:29:20 +0800 | [diff] [blame] | 175 | |
Brian O'Connor | ff27850 | 2015-09-22 14:49:52 -0700 | [diff] [blame] | 176 | String threads = get(properties, "workerThreads"); |
| 177 | if (!Strings.isNullOrEmpty(threads)) { |
| 178 | this.workerThreads = Integer.parseInt(threads); |
| 179 | } |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 180 | log.debug("Number of worker threads set to {}", this.workerThreads); |
| 181 | } |
| 182 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 183 | /** |
| 184 | * Initialize internal data structures. |
| 185 | */ |
Jonathan Hart | bbd91d4 | 2015-02-27 11:18:04 -0800 | [diff] [blame] | 186 | public void init() { |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 187 | // These data structures are initialized here because other |
| 188 | // module's startUp() might be called before ours |
Jonathan Hart | bbd91d4 | 2015-02-27 11:18:04 -0800 | [diff] [blame] | 189 | this.controllerNodeIPsCache = new HashMap<>(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 190 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 191 | this.systemStartTime = System.currentTimeMillis(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 192 | } |
| 193 | |
| 194 | // ************** |
| 195 | // Utility methods |
| 196 | // ************** |
| 197 | |
| 198 | public Map<String, Long> getMemory() { |
Jonathan Hart | bbd91d4 | 2015-02-27 11:18:04 -0800 | [diff] [blame] | 199 | Map<String, Long> m = new HashMap<>(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 200 | Runtime runtime = Runtime.getRuntime(); |
| 201 | m.put("total", runtime.totalMemory()); |
| 202 | m.put("free", runtime.freeMemory()); |
| 203 | return m; |
| 204 | } |
| 205 | |
| 206 | |
| 207 | public Long getUptime() { |
| 208 | RuntimeMXBean rb = ManagementFactory.getRuntimeMXBean(); |
| 209 | return rb.getUptime(); |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * Forward to the driver-manager to get an IOFSwitch instance. |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 214 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 215 | * @param dpid data path id |
| 216 | * @param desc switch description |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 217 | * @param ofv OpenFlow version |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 218 | * @return switch instance |
| 219 | */ |
| 220 | protected OpenFlowSwitchDriver getOFSwitchInstance(long dpid, |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 221 | OFDescStatsReply desc, |
| 222 | OFVersion ofv) { |
Jonathan Hart | a0d1249 | 2015-07-16 12:03:41 -0700 | [diff] [blame] | 223 | Dpid dpidObj = new Dpid(dpid); |
| 224 | |
| 225 | Driver driver; |
| 226 | try { |
Sho SHIMIZU | bc82ebb | 2015-08-25 10:15:21 -0700 | [diff] [blame] | 227 | driver = driverService.getDriver(DeviceId.deviceId(Dpid.uri(dpidObj))); |
Jonathan Hart | a0d1249 | 2015-07-16 12:03:41 -0700 | [diff] [blame] | 228 | } catch (ItemNotFoundException e) { |
| 229 | driver = driverService.getDriver(desc.getMfrDesc(), desc.getHwDesc(), desc.getSwDesc()); |
| 230 | } |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 231 | |
Thomas Vachuska | 3358af2 | 2015-05-19 18:40:34 -0700 | [diff] [blame] | 232 | if (driver != null && driver.hasBehaviour(OpenFlowSwitchDriver.class)) { |
Thomas Vachuska | 80b0a80 | 2015-07-17 08:43:30 -0700 | [diff] [blame] | 233 | Dpid did = new Dpid(dpid); |
| 234 | DefaultDriverHandler handler = |
| 235 | new DefaultDriverHandler(new DefaultDriverData(driver, deviceId(uri(did)))); |
| 236 | OpenFlowSwitchDriver ofSwitchDriver = |
| 237 | driver.createBehaviour(handler, OpenFlowSwitchDriver.class); |
| 238 | ofSwitchDriver.init(did, desc, ofv); |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 239 | ofSwitchDriver.setAgent(agent); |
| 240 | ofSwitchDriver.setRoleHandler(new RoleManager(ofSwitchDriver)); |
Saurav Das | 100e3b8 | 2015-04-30 11:12:10 -0700 | [diff] [blame] | 241 | log.info("OpenFlow handshaker found for device {}: {}", dpid, ofSwitchDriver); |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 242 | return ofSwitchDriver; |
| 243 | } |
| 244 | log.error("No OpenFlow driver for {} : {}", dpid, desc); |
| 245 | return null; |
| 246 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 247 | } |
| 248 | |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 249 | public void start(OpenFlowAgent ag, DriverService driverService) { |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 250 | log.info("Starting OpenFlow IO"); |
| 251 | this.agent = ag; |
alshabib | b452fd7 | 2015-04-22 20:46:20 -0700 | [diff] [blame] | 252 | this.driverService = driverService; |
Jonathan Hart | bbd91d4 | 2015-02-27 11:18:04 -0800 | [diff] [blame] | 253 | this.init(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 254 | this.run(); |
| 255 | } |
| 256 | |
| 257 | |
| 258 | public void stop() { |
| 259 | log.info("Stopping OpenFlow IO"); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 260 | cg.close(); |
Thomas Vachuska | 1c681d7 | 2015-05-18 14:58:53 -0700 | [diff] [blame] | 261 | execFactory.shutdown(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 262 | } |
| 263 | |
| 264 | } |