Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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.provider.nil; |
| 17 | |
| 18 | import com.google.common.collect.Lists; |
| 19 | import org.onlab.osgi.ServiceDirectory; |
| 20 | import org.onlab.packet.ChassisId; |
| 21 | import org.onlab.packet.IpAddress; |
| 22 | import org.onlab.packet.MacAddress; |
| 23 | import org.onlab.packet.VlanId; |
| 24 | import org.onosproject.cluster.ClusterService; |
| 25 | import org.onosproject.cluster.NodeId; |
| 26 | import org.onosproject.mastership.MastershipService; |
| 27 | import org.onosproject.net.ConnectPoint; |
| 28 | import org.onosproject.net.Device; |
| 29 | import org.onosproject.net.DeviceId; |
| 30 | import org.onosproject.net.Host; |
| 31 | import org.onosproject.net.HostId; |
| 32 | import org.onosproject.net.HostLocation; |
| 33 | import org.onosproject.net.Link; |
| 34 | import org.onosproject.net.Port; |
| 35 | import org.onosproject.net.PortNumber; |
| 36 | import org.onosproject.net.device.DefaultDeviceDescription; |
| 37 | import org.onosproject.net.device.DefaultPortDescription; |
| 38 | import org.onosproject.net.device.DeviceAdminService; |
| 39 | import org.onosproject.net.device.DeviceDescription; |
| 40 | import org.onosproject.net.device.DeviceEvent; |
| 41 | import org.onosproject.net.device.DeviceListener; |
| 42 | import org.onosproject.net.device.DeviceProviderService; |
| 43 | import org.onosproject.net.device.PortDescription; |
| 44 | import org.onosproject.net.host.DefaultHostDescription; |
| 45 | import org.onosproject.net.host.HostDescription; |
| 46 | import org.onosproject.net.host.HostProviderService; |
| 47 | import org.onosproject.net.host.HostService; |
| 48 | import org.onosproject.net.link.DefaultLinkDescription; |
| 49 | import org.onosproject.net.link.LinkProviderService; |
| 50 | import org.onosproject.net.link.LinkService; |
| 51 | import org.slf4j.Logger; |
| 52 | import org.slf4j.LoggerFactory; |
| 53 | |
| 54 | import java.util.List; |
| 55 | import java.util.concurrent.CountDownLatch; |
| 56 | import java.util.concurrent.TimeUnit; |
| 57 | |
| 58 | import static org.onlab.util.Tools.toHex; |
| 59 | import static org.onosproject.net.HostId.hostId; |
| 60 | import static org.onosproject.net.Link.Type.DIRECT; |
| 61 | import static org.onosproject.net.PortNumber.portNumber; |
| 62 | import static org.onosproject.net.device.DeviceEvent.Type.*; |
| 63 | import static org.onosproject.provider.nil.NullProviders.SCHEME; |
| 64 | |
| 65 | /** |
| 66 | * Abstraction of a provider capable to simulate some network topology. |
| 67 | */ |
| 68 | public abstract class TopologySimulator { |
| 69 | |
| 70 | protected final Logger log = LoggerFactory.getLogger(getClass()); |
| 71 | |
| 72 | protected String[] topoShape; |
| 73 | protected int deviceCount; |
| 74 | protected int hostCount; |
| 75 | |
| 76 | protected ServiceDirectory directory; |
| 77 | protected NodeId localNode; |
| 78 | |
| 79 | protected ClusterService clusterService; |
| 80 | protected MastershipService mastershipService; |
| 81 | |
| 82 | protected DeviceAdminService deviceService; |
| 83 | protected HostService hostService; |
| 84 | protected LinkService linkService; |
| 85 | |
| 86 | protected DeviceProviderService deviceProviderService; |
| 87 | protected HostProviderService hostProviderService; |
| 88 | protected LinkProviderService linkProviderService; |
| 89 | |
| 90 | protected int maxWaitSeconds = 1; |
| 91 | protected int infrastructurePorts = 2; |
| 92 | protected CountDownLatch deviceLatch; |
| 93 | |
| 94 | protected final List<DeviceId> deviceIds = Lists.newArrayList(); |
| 95 | |
| 96 | private DeviceListener deviceEventCounter = new DeviceEventCounter(); |
| 97 | |
| 98 | /** |
| 99 | * Initializes a new topology simulator with access to the specified service |
| 100 | * directory and various provider services. |
| 101 | * |
| 102 | * @param topoShape topology shape specifier |
| 103 | * @param deviceCount number of devices in the topology |
| 104 | * @param hostCount number of hosts per device |
| 105 | * @param directory service directory |
| 106 | * @param deviceProviderService device provider service |
| 107 | * @param hostProviderService host provider service |
| 108 | * @param linkProviderService link provider service |
| 109 | */ |
| 110 | protected void init(String topoShape, int deviceCount, int hostCount, |
| 111 | ServiceDirectory directory, |
| 112 | DeviceProviderService deviceProviderService, |
| 113 | HostProviderService hostProviderService, |
| 114 | LinkProviderService linkProviderService) { |
| 115 | this.deviceCount = deviceCount; |
| 116 | this.hostCount = hostCount; |
| 117 | this.directory = directory; |
| 118 | |
| 119 | this.clusterService = directory.get(ClusterService.class); |
| 120 | this.mastershipService = directory.get(MastershipService.class); |
| 121 | |
| 122 | this.deviceService = directory.get(DeviceAdminService.class); |
| 123 | this.hostService = directory.get(HostService.class); |
| 124 | this.linkService = directory.get(LinkService.class); |
| 125 | this.deviceProviderService = deviceProviderService; |
| 126 | this.hostProviderService = hostProviderService; |
| 127 | this.linkProviderService = linkProviderService; |
| 128 | |
| 129 | localNode = clusterService.getLocalNode().id(); |
| 130 | |
| 131 | processTopoShape(topoShape); |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Processes the topology shape specifier. |
| 136 | * |
| 137 | * @param shape topology shape specifier |
| 138 | */ |
| 139 | protected void processTopoShape(String shape) { |
| 140 | this.topoShape = shape.split(","); |
| 141 | } |
| 142 | |
| 143 | /** |
| 144 | * Sets up network topology simulation. |
| 145 | */ |
| 146 | public void setUpTopology() { |
| 147 | prepareForDeviceEvents(deviceCount); |
| 148 | createDevices(); |
| 149 | waitForDeviceEvents(); |
| 150 | |
| 151 | createLinks(); |
| 152 | createHosts(); |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Creates simulated devices. |
| 157 | */ |
| 158 | protected void createDevices() { |
| 159 | for (int i = 0; i < deviceCount; i++) { |
| 160 | createDevice(i + 1); |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Creates simulated links. |
| 166 | */ |
| 167 | protected abstract void createLinks(); |
| 168 | |
| 169 | /** |
| 170 | * Creates simulated hosts. |
| 171 | */ |
| 172 | protected abstract void createHosts(); |
| 173 | |
| 174 | /** |
Thomas Vachuska | 8e038eb | 2016-02-23 23:28:23 -0800 | [diff] [blame] | 175 | * Creates simulated device and adds its id to the list of devices ids. |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 176 | * |
| 177 | * @param i index of the device id in the list. |
| 178 | */ |
| 179 | protected void createDevice(int i) { |
| 180 | DeviceId id = DeviceId.deviceId(SCHEME + ":" + toHex(i)); |
Thomas Vachuska | 8e038eb | 2016-02-23 23:28:23 -0800 | [diff] [blame] | 181 | deviceIds.add(id); |
| 182 | createDevice(id, i); |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Creates simulated device. |
| 187 | * |
| 188 | * @param id device identifier |
| 189 | * @param chassisId chassis identifier number |
| 190 | */ |
| 191 | protected void createDevice(DeviceId id, int chassisId) { |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 192 | DeviceDescription desc = |
| 193 | new DefaultDeviceDescription(id.uri(), Device.Type.SWITCH, |
| 194 | "ON.Lab", "0.1", "0.1", "1234", |
Thomas Vachuska | 8e038eb | 2016-02-23 23:28:23 -0800 | [diff] [blame] | 195 | new ChassisId(chassisId)); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 196 | deviceProviderService.deviceConnected(id, desc); |
| 197 | deviceProviderService.updatePorts(id, buildPorts(hostCount + infrastructurePorts)); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | /** |
| 201 | * Creates simulated link between two devices. |
| 202 | * |
Thomas Vachuska | f651cc9 | 2015-04-14 16:11:44 -0700 | [diff] [blame] | 203 | * @param i index of one simulated device |
| 204 | * @param j index of another simulated device |
| 205 | * @param pi port number of i-th device |
| 206 | * @param pj port number of j-th device |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 207 | */ |
Thomas Vachuska | f651cc9 | 2015-04-14 16:11:44 -0700 | [diff] [blame] | 208 | protected void createLink(int i, int j, int pi, int pj) { |
| 209 | ConnectPoint one = new ConnectPoint(deviceIds.get(i), PortNumber.portNumber(pi)); |
| 210 | ConnectPoint two = new ConnectPoint(deviceIds.get(j), PortNumber.portNumber(pj)); |
Thomas Vachuska | 8e038eb | 2016-02-23 23:28:23 -0800 | [diff] [blame] | 211 | createLink(one, two); |
| 212 | } |
| 213 | |
| 214 | /** |
| 215 | * Creates simulated link between two connection points. |
| 216 | * |
| 217 | * @param one one connection point |
| 218 | * @param two another connection point |
| 219 | */ |
| 220 | protected void createLink(ConnectPoint one, ConnectPoint two) { |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 221 | linkProviderService.linkDetected(new DefaultLinkDescription(one, two, DIRECT)); |
| 222 | linkProviderService.linkDetected(new DefaultLinkDescription(two, one, DIRECT)); |
| 223 | } |
| 224 | |
| 225 | /** |
| 226 | * Creates simularted hosts for the specified device. |
| 227 | * |
| 228 | * @param deviceId device identifier |
| 229 | * @param portOffset port offset where to start attaching hosts |
| 230 | */ |
| 231 | protected void createHosts(DeviceId deviceId, int portOffset) { |
| 232 | String s = deviceId.toString(); |
| 233 | byte dByte = Byte.parseByte(s.substring(s.length() - 1), 16); |
| 234 | // TODO: this limits the simulation to 256 devices & 256 hosts/device. |
| 235 | byte[] macBytes = new byte[]{0, 0, 0, 0, dByte, 0}; |
| 236 | byte[] ipBytes = new byte[]{(byte) 192, (byte) 168, dByte, 0}; |
| 237 | |
| 238 | for (int i = 0; i < hostCount; i++) { |
| 239 | int port = portOffset + i + 1; |
| 240 | macBytes[5] = (byte) (i + 1); |
| 241 | ipBytes[3] = (byte) (i + 1); |
| 242 | HostId id = hostId(MacAddress.valueOf(macBytes), VlanId.NONE); |
| 243 | IpAddress ip = IpAddress.valueOf(IpAddress.Version.INET, ipBytes); |
Ray Milkey | dc08344 | 2016-02-22 11:27:57 -0800 | [diff] [blame] | 244 | hostProviderService.hostDetected(id, description(id, ip, deviceId, port), false); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 245 | } |
| 246 | } |
| 247 | |
| 248 | /** |
| 249 | * Prepares to count device added/available/removed events. |
| 250 | * |
| 251 | * @param count number of events to count |
| 252 | */ |
| 253 | protected void prepareForDeviceEvents(int count) { |
| 254 | deviceLatch = new CountDownLatch(count); |
| 255 | deviceService.addListener(deviceEventCounter); |
| 256 | } |
| 257 | |
| 258 | /** |
| 259 | * Waits for all expected device added/available/removed events. |
| 260 | */ |
| 261 | protected void waitForDeviceEvents() { |
| 262 | try { |
| 263 | deviceLatch.await(maxWaitSeconds, TimeUnit.SECONDS); |
| 264 | } catch (InterruptedException e) { |
| 265 | log.warn("Device events did not arrive in time"); |
| 266 | } |
| 267 | deviceService.removeListener(deviceEventCounter); |
| 268 | } |
| 269 | |
| 270 | |
| 271 | /** |
| 272 | * Tears down network topology simulation. |
| 273 | */ |
| 274 | public void tearDownTopology() { |
| 275 | removeHosts(); |
| 276 | removeLinks(); |
| 277 | removeDevices(); |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Removes any hosts previously advertised by this provider. |
| 282 | */ |
| 283 | protected void removeHosts() { |
| 284 | hostService.getHosts() |
| 285 | .forEach(host -> hostProviderService.hostVanished(host.id())); |
| 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Removes any links previously advertised by this provider. |
| 290 | */ |
| 291 | protected void removeLinks() { |
| 292 | linkService.getLinks() |
| 293 | .forEach(link -> linkProviderService.linkVanished(description(link))); |
| 294 | } |
| 295 | |
| 296 | /** |
| 297 | * Removes any devices previously advertised by this provider. |
| 298 | */ |
| 299 | protected void removeDevices() { |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 300 | prepareForDeviceEvents(deviceIds.size()); |
| 301 | deviceIds.forEach(deviceProviderService::deviceDisconnected); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 302 | waitForDeviceEvents(); |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 303 | deviceIds.clear(); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | |
| 307 | /** |
| 308 | * Produces a device description from the given device. |
| 309 | * |
| 310 | * @param device device to copy |
| 311 | * @return device description |
| 312 | */ |
| 313 | static DeviceDescription description(Device device) { |
| 314 | return new DefaultDeviceDescription(device.id().uri(), device.type(), |
| 315 | device.manufacturer(), |
| 316 | device.hwVersion(), device.swVersion(), |
| 317 | device.serialNumber(), device.chassisId()); |
| 318 | } |
| 319 | |
| 320 | /** |
| 321 | * Produces a link description from the given link. |
| 322 | * |
| 323 | * @param link link to copy |
| 324 | * @return link description |
| 325 | */ |
| 326 | static DefaultLinkDescription description(Link link) { |
| 327 | return new DefaultLinkDescription(link.src(), link.dst(), link.type()); |
| 328 | } |
| 329 | |
| 330 | /** |
| 331 | * Produces a host description from the given host. |
| 332 | * |
| 333 | * @param host host to copy |
| 334 | * @return host description |
| 335 | */ |
| 336 | static DefaultHostDescription description(Host host) { |
| 337 | return new DefaultHostDescription(host.mac(), host.vlan(), host.location(), |
| 338 | host.ipAddresses()); |
| 339 | } |
| 340 | |
| 341 | /** |
| 342 | * Generates a host description from the given id and location information. |
| 343 | * |
| 344 | * @param hostId host identifier |
| 345 | * @param ip host IP |
| 346 | * @param deviceId edge device |
| 347 | * @param port edge port |
| 348 | * @return host description |
| 349 | */ |
| 350 | static HostDescription description(HostId hostId, IpAddress ip, |
| 351 | DeviceId deviceId, int port) { |
| 352 | HostLocation location = new HostLocation(deviceId, portNumber(port), 0L); |
| 353 | return new DefaultHostDescription(hostId.mac(), hostId.vlanId(), location, ip); |
| 354 | } |
| 355 | |
| 356 | /** |
| 357 | * Generates a list of a configured number of ports. |
| 358 | * |
| 359 | * @param portCount number of ports |
| 360 | * @return list of ports |
| 361 | */ |
| 362 | protected List<PortDescription> buildPorts(int portCount) { |
| 363 | List<PortDescription> ports = Lists.newArrayList(); |
| 364 | for (int i = 0; i < portCount; i++) { |
| 365 | ports.add(new DefaultPortDescription(PortNumber.portNumber(i), true, |
| 366 | Port.Type.COPPER, 0)); |
| 367 | } |
| 368 | return ports; |
| 369 | } |
| 370 | |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 371 | /** |
Thomas Vachuska | 8e038eb | 2016-02-23 23:28:23 -0800 | [diff] [blame] | 372 | * Indicates whether or not the simulation deeps the device as available. |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 373 | * |
| 374 | * @param deviceId device identifier |
| 375 | * @return true if device is known |
| 376 | */ |
| 377 | public boolean contains(DeviceId deviceId) { |
| 378 | return deviceIds.contains(deviceId); |
| 379 | } |
| 380 | |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 381 | // Counts down number of device added/available/removed events. |
| 382 | private class DeviceEventCounter implements DeviceListener { |
| 383 | @Override |
| 384 | public void event(DeviceEvent event) { |
| 385 | DeviceEvent.Type type = event.type(); |
| 386 | if (type == DEVICE_ADDED || type == DEVICE_REMOVED || |
| 387 | type == DEVICE_AVAILABILITY_CHANGED) { |
| 388 | deviceLatch.countDown(); |
| 389 | } |
| 390 | } |
| 391 | } |
Ray Milkey | dc08344 | 2016-02-22 11:27:57 -0800 | [diff] [blame] | 392 | } |