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 org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Modified; |
| 22 | import org.apache.felix.scr.annotations.Property; |
| 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 25 | import org.apache.felix.scr.annotations.Service; |
| 26 | import org.onlab.osgi.DefaultServiceDirectory; |
| 27 | import org.onosproject.cfg.ComponentConfigService; |
| 28 | import org.onosproject.cluster.ClusterService; |
| 29 | import org.onosproject.cluster.NodeId; |
| 30 | import org.onosproject.mastership.MastershipAdminService; |
| 31 | import org.onosproject.net.ConnectPoint; |
| 32 | import org.onosproject.net.DeviceId; |
| 33 | import org.onosproject.net.Host; |
| 34 | import org.onosproject.net.MastershipRole; |
| 35 | import org.onosproject.net.device.DeviceAdminService; |
| 36 | import org.onosproject.net.device.DeviceProvider; |
| 37 | import org.onosproject.net.device.DeviceProviderRegistry; |
| 38 | import org.onosproject.net.device.DeviceProviderService; |
| 39 | import org.onosproject.net.flow.FlowRuleProviderRegistry; |
| 40 | import org.onosproject.net.flow.FlowRuleProviderService; |
| 41 | import org.onosproject.net.host.HostProvider; |
| 42 | import org.onosproject.net.host.HostProviderRegistry; |
| 43 | import org.onosproject.net.host.HostProviderService; |
| 44 | import org.onosproject.net.host.HostService; |
| 45 | import org.onosproject.net.link.LinkProvider; |
| 46 | import org.onosproject.net.link.LinkProviderRegistry; |
| 47 | import org.onosproject.net.link.LinkProviderService; |
| 48 | import org.onosproject.net.link.LinkService; |
| 49 | import org.onosproject.net.packet.PacketProviderRegistry; |
| 50 | import org.onosproject.net.packet.PacketProviderService; |
| 51 | import org.onosproject.net.provider.AbstractProvider; |
| 52 | import org.onosproject.net.provider.ProviderId; |
| 53 | import org.osgi.service.component.ComponentContext; |
| 54 | import org.slf4j.Logger; |
| 55 | |
| 56 | import java.util.Dictionary; |
| 57 | import java.util.Properties; |
| 58 | |
| 59 | import static com.google.common.base.Strings.isNullOrEmpty; |
| 60 | import static org.onlab.util.Tools.delay; |
| 61 | import static org.onlab.util.Tools.get; |
| 62 | import static org.onosproject.net.DeviceId.deviceId; |
| 63 | import static org.onosproject.net.MastershipRole.MASTER; |
| 64 | import static org.onosproject.net.MastershipRole.NONE; |
| 65 | import static org.slf4j.LoggerFactory.getLogger; |
| 66 | |
| 67 | /** |
| 68 | * Provider of a fake network environment, i.e. devices, links, hosts, etc. |
| 69 | * To be used for benchmarking only. |
| 70 | */ |
| 71 | @Component(immediate = true) |
| 72 | @Service(value = NullProviders.class) |
| 73 | public class NullProviders { |
| 74 | |
| 75 | private static final Logger log = getLogger(NullProviders.class); |
| 76 | |
| 77 | static final String SCHEME = "null"; |
| 78 | static final String PROVIDER_ID = "org.onosproject.provider.nil"; |
| 79 | |
| 80 | private static final String FORMAT = |
| 81 | "Settings: enabled={}, topoShape={}, deviceCount={}, " + |
| 82 | "hostCount={}, packetRate={}, mutationRate={}"; |
| 83 | |
| 84 | |
| 85 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 86 | protected ClusterService clusterService; |
| 87 | |
| 88 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 89 | protected MastershipAdminService mastershipService; |
| 90 | |
| 91 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 92 | protected ComponentConfigService cfgService; |
| 93 | |
| 94 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 95 | protected DeviceAdminService deviceService; |
| 96 | |
| 97 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 98 | protected HostService hostService; |
| 99 | |
| 100 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 101 | protected LinkService linkService; |
| 102 | |
| 103 | |
| 104 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 105 | protected DeviceProviderRegistry deviceProviderRegistry; |
| 106 | |
| 107 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 108 | protected HostProviderRegistry hostProviderRegistry; |
| 109 | |
| 110 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 111 | protected LinkProviderRegistry linkProviderRegistry; |
| 112 | |
| 113 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 114 | protected FlowRuleProviderRegistry flowRuleProviderRegistry; |
| 115 | |
| 116 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 117 | protected PacketProviderRegistry packetProviderRegistry; |
| 118 | |
| 119 | |
| 120 | private final NullDeviceProvider deviceProvider = new NullDeviceProvider(); |
| 121 | private final NullLinkProvider linkProvider = new NullLinkProvider(); |
| 122 | private final NullHostProvider hostProvider = new NullHostProvider(); |
| 123 | private final NullFlowRuleProvider flowRuleProvider = new NullFlowRuleProvider(); |
| 124 | private final NullPacketProvider packetProvider = new NullPacketProvider(); |
| 125 | private final TopologyMutationDriver topologyMutationDriver = new TopologyMutationDriver(); |
| 126 | |
| 127 | private DeviceProviderService deviceProviderService; |
| 128 | private HostProviderService hostProviderService; |
| 129 | private LinkProviderService linkProviderService; |
| 130 | private FlowRuleProviderService flowRuleProviderService; |
| 131 | private PacketProviderService packetProviderService; |
| 132 | |
| 133 | private TopologySimulator simulator; |
| 134 | |
| 135 | @Property(name = "enabled", boolValue = false, |
| 136 | label = "Enables or disables the provider") |
| 137 | private boolean enabled = false; |
| 138 | |
| 139 | private static final String DEFAULT_TOPO_SHAPE = "configured"; |
| 140 | @Property(name = "topoShape", value = DEFAULT_TOPO_SHAPE, |
| 141 | label = "Topology shape: configured, linear, reroute, tree, spineleaf, mesh") |
| 142 | private String topoShape = DEFAULT_TOPO_SHAPE; |
| 143 | |
| 144 | private static final int DEFAULT_DEVICE_COUNT = 10; |
| 145 | @Property(name = "deviceCount", intValue = DEFAULT_DEVICE_COUNT, |
| 146 | label = "Number of devices to generate") |
| 147 | private int deviceCount = DEFAULT_DEVICE_COUNT; |
| 148 | |
| 149 | private static final int DEFAULT_HOST_COUNT = 5; |
| 150 | @Property(name = "hostCount", intValue = DEFAULT_HOST_COUNT, |
| 151 | label = "Number of host to generate per device") |
| 152 | private int hostCount = DEFAULT_HOST_COUNT; |
| 153 | |
| 154 | private static final int DEFAULT_PACKET_RATE = 5; |
| 155 | @Property(name = "packetRate", intValue = DEFAULT_PACKET_RATE, |
| 156 | label = "Packet-in/s rate; 0 for no packets") |
| 157 | private int packetRate = DEFAULT_PACKET_RATE; |
| 158 | |
| 159 | private static final double DEFAULT_MUTATION_RATE = 0; |
| 160 | @Property(name = "mutationRate", doubleValue = DEFAULT_MUTATION_RATE, |
| 161 | label = "Link event/s topology mutation rate; 0 for no mutations") |
| 162 | private double mutationRate = DEFAULT_MUTATION_RATE; |
| 163 | |
| 164 | private static final String DEFAULT_MASTERSHIP = "random"; |
| 165 | @Property(name = "mastership", value = DEFAULT_MASTERSHIP, |
| 166 | label = "Mastership given as 'random' or 'node1=dpid,dpid/node2=dpid,...'") |
| 167 | private String mastership = DEFAULT_MASTERSHIP; |
| 168 | |
| 169 | |
| 170 | @Activate |
| 171 | public void activate(ComponentContext context) { |
| 172 | cfgService.registerProperties(getClass()); |
| 173 | |
| 174 | deviceProviderService = deviceProviderRegistry.register(deviceProvider); |
| 175 | hostProviderService = hostProviderRegistry.register(hostProvider); |
| 176 | linkProviderService = linkProviderRegistry.register(linkProvider); |
| 177 | flowRuleProviderService = flowRuleProviderRegistry.register(flowRuleProvider); |
| 178 | packetProviderService = packetProviderRegistry.register(packetProvider); |
| 179 | log.info("Started"); |
| 180 | } |
| 181 | |
| 182 | @Deactivate |
| 183 | public void deactivate(ComponentContext context) { |
| 184 | cfgService.unregisterProperties(getClass(), false); |
| 185 | tearDown(); |
| 186 | |
| 187 | deviceProviderRegistry.unregister(deviceProvider); |
| 188 | hostProviderRegistry.unregister(hostProvider); |
| 189 | linkProviderRegistry.unregister(linkProvider); |
| 190 | flowRuleProviderRegistry.unregister(flowRuleProvider); |
| 191 | packetProviderRegistry.unregister(packetProvider); |
| 192 | |
| 193 | deviceProviderService = null; |
| 194 | hostProviderService = null; |
| 195 | linkProviderService = null; |
| 196 | flowRuleProviderService = null; |
| 197 | packetProviderService = null; |
| 198 | |
| 199 | log.info("Stopped"); |
| 200 | } |
| 201 | |
| 202 | @Modified |
| 203 | public void modified(ComponentContext context) { |
| 204 | Dictionary<?, ?> properties = context != null ? context.getProperties() : new Properties(); |
| 205 | |
| 206 | boolean newEnabled; |
| 207 | int newDeviceCount, newHostCount, newPacketRate; |
| 208 | double newMutationRate; |
| 209 | String newTopoShape, newMastership; |
| 210 | try { |
| 211 | String s = get(properties, "enabled"); |
| 212 | newEnabled = isNullOrEmpty(s) ? enabled : Boolean.parseBoolean(s.trim()); |
| 213 | |
| 214 | newTopoShape = get(properties, "topoShape"); |
| 215 | newMastership = get(properties, "mastership"); |
| 216 | |
| 217 | s = get(properties, "deviceCount"); |
| 218 | newDeviceCount = isNullOrEmpty(s) ? deviceCount : Integer.parseInt(s.trim()); |
| 219 | |
| 220 | s = get(properties, "hostCount"); |
| 221 | newHostCount = isNullOrEmpty(s) ? hostCount : Integer.parseInt(s.trim()); |
| 222 | |
| 223 | s = get(properties, "packetRate"); |
| 224 | newPacketRate = isNullOrEmpty(s) ? packetRate : Integer.parseInt(s.trim()); |
| 225 | |
| 226 | s = get(properties, "mutationRate"); |
| 227 | newMutationRate = isNullOrEmpty(s) ? mutationRate : Double.parseDouble(s.trim()); |
| 228 | |
| 229 | } catch (NumberFormatException e) { |
| 230 | log.warn(e.getMessage()); |
| 231 | newEnabled = enabled; |
| 232 | newTopoShape = topoShape; |
| 233 | newDeviceCount = deviceCount; |
| 234 | newHostCount = hostCount; |
| 235 | newPacketRate = packetRate; |
| 236 | newMutationRate = mutationRate; |
| 237 | newMastership = mastership; |
| 238 | } |
| 239 | |
| 240 | // Any change in the following parameters implies hard restart |
| 241 | if (newEnabled != enabled || !newTopoShape.equals(topoShape) || |
| 242 | newDeviceCount != deviceCount || newHostCount != hostCount) { |
| 243 | enabled = newEnabled; |
| 244 | topoShape = newTopoShape; |
| 245 | deviceCount = newDeviceCount; |
| 246 | hostCount = newHostCount; |
| 247 | packetRate = newPacketRate; |
| 248 | mutationRate = newMutationRate; |
| 249 | restartSimulation(); |
| 250 | } |
| 251 | |
| 252 | // Any change in the following parameters implies just a rate change |
| 253 | if (newPacketRate != packetRate || newMutationRate != mutationRate) { |
| 254 | packetRate = newPacketRate; |
| 255 | mutationRate = newMutationRate; |
| 256 | adjustRates(); |
| 257 | } |
| 258 | |
| 259 | // Any change in mastership implies just reassignments. |
| 260 | if (!newMastership.equals(mastership)) { |
| 261 | mastership = newMastership; |
| 262 | reassignMastership(); |
| 263 | } |
| 264 | |
| 265 | log.info(FORMAT, enabled, topoShape, deviceCount, hostCount, |
| 266 | packetRate, mutationRate); |
| 267 | } |
| 268 | |
| 269 | /** |
| 270 | * Severs the link between the specified end-points in both directions. |
| 271 | * |
| 272 | * @param one link endpoint |
| 273 | * @param two link endpoint |
| 274 | */ |
| 275 | public void severLink(ConnectPoint one, ConnectPoint two) { |
| 276 | if (enabled) { |
| 277 | topologyMutationDriver.severLink(one, two); |
| 278 | } |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * Severs the link between the specified end-points in both directions. |
| 283 | * |
| 284 | * @param one link endpoint |
| 285 | * @param two link endpoint |
| 286 | */ |
| 287 | public void repairLink(ConnectPoint one, ConnectPoint two) { |
| 288 | if (enabled) { |
| 289 | topologyMutationDriver.repairLink(one, two); |
| 290 | } |
| 291 | } |
| 292 | |
| 293 | // Resets simulation based on the current configuration parameters. |
| 294 | private void restartSimulation() { |
| 295 | tearDown(); |
| 296 | if (enabled) { |
| 297 | setUp(); |
| 298 | } |
| 299 | } |
| 300 | |
| 301 | // Sets up the topology simulation and all providers. |
| 302 | private void setUp() { |
| 303 | simulator = selectSimulator(topoShape); |
| 304 | simulator.init(topoShape, deviceCount, hostCount, |
| 305 | new DefaultServiceDirectory(), |
| 306 | deviceProviderService, hostProviderService, |
| 307 | linkProviderService); |
| 308 | simulator.setUpTopology(); |
| 309 | flowRuleProvider.start(flowRuleProviderService); |
| 310 | packetProvider.start(packetRate, hostService, deviceService, |
| 311 | packetProviderService); |
| 312 | topologyMutationDriver.start(mutationRate, linkService, deviceService, |
| 313 | linkProviderService); |
| 314 | } |
| 315 | |
| 316 | // Selects the simulator based on the specified name. |
| 317 | private TopologySimulator selectSimulator(String topoShape) { |
| 318 | if (topoShape.matches("linear([,].*|$)")) { |
| 319 | return new LinearTopologySimulator(); |
| 320 | } else if (topoShape.matches("centipede([,].*|$)")) { |
| 321 | return new CentipedeTopologySimulator(); |
| 322 | } else if (topoShape.matches("reroute([,].*|$)")) { |
| 323 | return new RerouteTopologySimulator(); |
| 324 | } else if (topoShape.matches("tree([,].*|$)")) { |
| 325 | return new TreeTopologySimulator(); |
Thomas Vachuska | 59da18d | 2015-07-07 17:44:21 -0700 | [diff] [blame] | 326 | } else if (topoShape.matches("agglink([,].*|$)")) { |
| 327 | return new AggLinkTopologySimulator(); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 328 | } else if (topoShape.matches("spineleaf([,].*|$)")) { |
| 329 | return new SpineLeafTopologySimulator(); |
| 330 | } else if (topoShape.matches("mesh([,].*|$)")) { |
| 331 | return new MeshTopologySimulator(); |
| 332 | } else { |
| 333 | return new ConfiguredTopologySimulator(); |
| 334 | } |
| 335 | } |
| 336 | |
| 337 | // Shuts down the topology simulator and all providers. |
| 338 | private void tearDown() { |
| 339 | if (simulator != null) { |
| 340 | topologyMutationDriver.stop(); |
| 341 | packetProvider.stop(); |
| 342 | flowRuleProvider.stop(); |
| 343 | delay(500); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 344 | simulator.tearDownTopology(); |
| 345 | simulator = null; |
| 346 | } |
| 347 | } |
| 348 | |
| 349 | // Changes packet and mutation rates. |
| 350 | private void adjustRates() { |
| 351 | packetProvider.adjustRate(packetRate); |
| 352 | topologyMutationDriver.adjustRate(mutationRate); |
| 353 | } |
| 354 | |
| 355 | // Re-assigns mastership roles. |
| 356 | private void reassignMastership() { |
| 357 | if (mastership.equals(DEFAULT_MASTERSHIP)) { |
| 358 | mastershipService.balanceRoles(); |
| 359 | } else { |
| 360 | NodeId localNode = clusterService.getLocalNode().id(); |
| 361 | rejectMastership(); |
| 362 | String[] nodeSpecs = mastership.split("/"); |
| 363 | for (int i = 0; i < nodeSpecs.length; i++) { |
| 364 | String[] specs = nodeSpecs[i].split("="); |
| 365 | if (specs[0].equals(localNode.toString())) { |
| 366 | String[] ids = specs[1].split(","); |
| 367 | for (String id : ids) { |
| 368 | mastershipService.setRole(localNode, deviceId(id), MASTER); |
| 369 | } |
| 370 | break; |
| 371 | } |
| 372 | } |
| 373 | } |
| 374 | } |
| 375 | |
| 376 | // Rejects mastership of all devices. |
| 377 | private void rejectMastership() { |
| 378 | NodeId localNode = clusterService.getLocalNode().id(); |
| 379 | deviceService.getDevices() |
| 380 | .forEach(device -> mastershipService.setRole(localNode, device.id(), |
| 381 | NONE)); |
| 382 | } |
| 383 | |
| 384 | // Null provider base class. |
| 385 | abstract static class AbstractNullProvider extends AbstractProvider { |
| 386 | protected AbstractNullProvider() { |
| 387 | super(new ProviderId(SCHEME, PROVIDER_ID)); |
| 388 | } |
| 389 | } |
| 390 | |
| 391 | // Device provider facade. |
| 392 | private class NullDeviceProvider extends AbstractNullProvider implements DeviceProvider { |
| 393 | @Override |
| 394 | public void roleChanged(DeviceId deviceId, MastershipRole newRole) { |
| 395 | deviceProviderService.receivedRoleReply(deviceId, newRole, newRole); |
| 396 | } |
| 397 | |
| 398 | @Override |
| 399 | public boolean isReachable(DeviceId deviceId) { |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 400 | return topoShape.equals("configured") || |
| 401 | (simulator != null && simulator.contains(deviceId)); |
Thomas Vachuska | c40d463 | 2015-04-09 16:55:03 -0700 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | @Override |
| 405 | public void triggerProbe(DeviceId deviceId) { |
| 406 | } |
| 407 | } |
| 408 | |
| 409 | // Host provider facade. |
| 410 | private class NullHostProvider extends AbstractNullProvider implements HostProvider { |
| 411 | @Override |
| 412 | public void triggerProbe(Host host) { |
| 413 | } |
| 414 | } |
| 415 | |
| 416 | // Host provider facade. |
| 417 | private class NullLinkProvider extends AbstractNullProvider implements LinkProvider { |
| 418 | } |
| 419 | |
| 420 | } |