Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 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.openstacknetworking.impl; |
| 17 | |
| 18 | import com.google.common.base.Strings; |
| 19 | import org.apache.felix.scr.annotations.Activate; |
| 20 | import org.apache.felix.scr.annotations.Component; |
| 21 | import org.apache.felix.scr.annotations.Deactivate; |
| 22 | import org.apache.felix.scr.annotations.Reference; |
| 23 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 24 | import org.apache.felix.scr.annotations.Service; |
| 25 | import org.onlab.packet.IpAddress; |
| 26 | import org.onlab.packet.MacAddress; |
| 27 | import org.onlab.packet.VlanId; |
| 28 | import org.onlab.util.Tools; |
| 29 | import org.onosproject.core.CoreService; |
| 30 | import org.onosproject.mastership.MastershipService; |
| 31 | import org.onosproject.net.ConnectPoint; |
| 32 | import org.onosproject.net.DefaultAnnotations; |
| 33 | import org.onosproject.net.Device; |
| 34 | import org.onosproject.net.Host; |
| 35 | import org.onosproject.net.HostId; |
| 36 | import org.onosproject.net.HostLocation; |
| 37 | import org.onosproject.net.Port; |
| 38 | import org.onosproject.net.device.DeviceEvent; |
| 39 | import org.onosproject.net.device.DeviceListener; |
| 40 | import org.onosproject.net.device.DeviceService; |
| 41 | import org.onosproject.net.host.DefaultHostDescription; |
| 42 | import org.onosproject.net.host.HostDescription; |
| 43 | import org.onosproject.net.host.HostProvider; |
| 44 | import org.onosproject.net.host.HostProviderRegistry; |
| 45 | import org.onosproject.net.host.HostProviderService; |
| 46 | import org.onosproject.net.host.HostService; |
| 47 | import org.onosproject.net.provider.AbstractProvider; |
| 48 | import org.onosproject.net.provider.ProviderId; |
| 49 | import org.onosproject.openstacknetworking.api.OpenstackNetworkService; |
Hyunsun Moon | 0d45736 | 2017-06-27 17:19:41 +0900 | [diff] [blame] | 50 | import org.onosproject.openstacknode.api.OpenstackNode; |
| 51 | import org.onosproject.openstacknode.api.OpenstackNodeEvent; |
| 52 | import org.onosproject.openstacknode.api.OpenstackNodeListener; |
| 53 | import org.onosproject.openstacknode.api.OpenstackNodeService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 54 | import org.openstack4j.model.network.Network; |
daniel park | 796c2eb | 2018-03-22 17:01:51 +0900 | [diff] [blame] | 55 | import org.openstack4j.model.network.NetworkType; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 56 | import org.slf4j.Logger; |
| 57 | import org.slf4j.LoggerFactory; |
| 58 | |
| 59 | import java.util.Set; |
| 60 | import java.util.concurrent.ExecutorService; |
| 61 | import java.util.concurrent.Executors; |
| 62 | import java.util.stream.Collectors; |
| 63 | |
| 64 | import static org.onlab.util.Tools.groupedThreads; |
| 65 | import static org.onosproject.net.AnnotationKeys.PORT_NAME; |
daniel park | 796c2eb | 2018-03-22 17:01:51 +0900 | [diff] [blame] | 66 | import static org.onosproject.openstacknetworking.api.Constants.OPENSTACK_NETWORKING_APP_ID; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 67 | import static org.onosproject.openstacknetworking.impl.HostBasedInstancePort.ANNOTATION_CREATE_TIME; |
| 68 | import static org.onosproject.openstacknetworking.impl.HostBasedInstancePort.ANNOTATION_NETWORK_ID; |
| 69 | import static org.onosproject.openstacknetworking.impl.HostBasedInstancePort.ANNOTATION_PORT_ID; |
| 70 | |
| 71 | @Service |
| 72 | @Component(immediate = true) |
| 73 | public final class OpenstackSwitchingHostProvider extends AbstractProvider implements HostProvider { |
| 74 | |
| 75 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 76 | |
| 77 | private static final String PORT_NAME_PREFIX_VM = "tap"; |
| 78 | private static final String ERR_ADD_HOST = "Failed to add host: "; |
daniel park | 5fe3079 | 2017-08-22 15:42:54 +0900 | [diff] [blame] | 79 | private static final String ANNOTATION_SEGMENT_ID = "segId"; |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 80 | private static final String SONA_HOST_SCHEME = "sona"; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 81 | |
| 82 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 83 | protected CoreService coreService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 84 | |
| 85 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 86 | protected DeviceService deviceService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 87 | |
| 88 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 89 | protected HostProviderRegistry hostProviderRegistry; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 90 | |
| 91 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 92 | protected HostService hostService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 93 | |
| 94 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 95 | protected MastershipService mastershipService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 96 | |
| 97 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 98 | protected OpenstackNetworkService osNetworkService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 99 | |
| 100 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 101 | protected OpenstackNodeService osNodeService; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 102 | |
| 103 | private final ExecutorService deviceEventExecutor = |
| 104 | Executors.newSingleThreadExecutor(groupedThreads("openstacknetworking", "device-event")); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 105 | private final InternalDeviceListener internalDeviceListener = new InternalDeviceListener(); |
| 106 | private final InternalOpenstackNodeListener internalNodeListener = new InternalOpenstackNodeListener(); |
| 107 | |
| 108 | private HostProviderService hostProvider; |
| 109 | |
| 110 | /** |
| 111 | * Creates OpenStack switching host provider. |
| 112 | */ |
| 113 | public OpenstackSwitchingHostProvider() { |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 114 | super(new ProviderId(SONA_HOST_SCHEME, OPENSTACK_NETWORKING_APP_ID)); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | @Activate |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 118 | void activate() { |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 119 | coreService.registerApplication(OPENSTACK_NETWORKING_APP_ID); |
| 120 | deviceService.addListener(internalDeviceListener); |
| 121 | osNodeService.addListener(internalNodeListener); |
| 122 | hostProvider = hostProviderRegistry.register(this); |
| 123 | |
| 124 | log.info("Started"); |
| 125 | } |
| 126 | |
| 127 | @Deactivate |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 128 | void deactivate() { |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 129 | hostProviderRegistry.unregister(this); |
| 130 | osNodeService.removeListener(internalNodeListener); |
| 131 | deviceService.removeListener(internalDeviceListener); |
| 132 | |
| 133 | deviceEventExecutor.shutdown(); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 134 | |
| 135 | log.info("Stopped"); |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public void triggerProbe(Host host) { |
| 140 | // no probe is required |
| 141 | } |
| 142 | |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 143 | /** |
| 144 | * Processes port addition event. |
| 145 | * Once a port addition event is detected, it tries to create a host instance |
| 146 | * with openstack augmented host information such as networkId, portId, |
| 147 | * createTime, segmentId and notifies to host provider. |
| 148 | * |
| 149 | * @param port port object used in ONOS |
| 150 | */ |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 151 | private void processPortAdded(Port port) { |
| 152 | // TODO check the node state is COMPLETE |
| 153 | org.openstack4j.model.network.Port osPort = osNetworkService.port(port); |
| 154 | if (osPort == null) { |
| 155 | log.warn(ERR_ADD_HOST + "OpenStack port for {} not found", port); |
| 156 | return; |
| 157 | } |
| 158 | |
| 159 | Network osNet = osNetworkService.network(osPort.getNetworkId()); |
| 160 | if (osNet == null) { |
| 161 | log.warn(ERR_ADD_HOST + "OpenStack network {} not found", |
| 162 | osPort.getNetworkId()); |
| 163 | return; |
| 164 | } |
| 165 | |
| 166 | if (osPort.getFixedIps().isEmpty()) { |
| 167 | log.warn(ERR_ADD_HOST + "no fixed IP for port {}", osPort.getId()); |
| 168 | return; |
| 169 | } |
| 170 | |
| 171 | MacAddress macAddr = MacAddress.valueOf(osPort.getMacAddress()); |
| 172 | Set<IpAddress> fixedIps = osPort.getFixedIps().stream() |
| 173 | .map(ip -> IpAddress.valueOf(ip.getIpAddress())) |
| 174 | .collect(Collectors.toSet()); |
| 175 | ConnectPoint connectPoint = new ConnectPoint(port.element().id(), port.number()); |
| 176 | |
| 177 | DefaultAnnotations.Builder annotations = DefaultAnnotations.builder() |
| 178 | .set(ANNOTATION_NETWORK_ID, osPort.getNetworkId()) |
| 179 | .set(ANNOTATION_PORT_ID, osPort.getId()) |
daniel park | 796c2eb | 2018-03-22 17:01:51 +0900 | [diff] [blame] | 180 | .set(ANNOTATION_CREATE_TIME, String.valueOf(System.currentTimeMillis())); |
| 181 | |
| 182 | if (osNet.getNetworkType() != NetworkType.FLAT) { |
| 183 | annotations.set(ANNOTATION_SEGMENT_ID, osNet.getProviderSegID()); |
| 184 | |
| 185 | } |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 186 | |
| 187 | HostDescription hostDesc = new DefaultHostDescription( |
| 188 | macAddr, |
| 189 | VlanId.NONE, |
| 190 | new HostLocation(connectPoint, System.currentTimeMillis()), |
| 191 | fixedIps, |
| 192 | annotations.build()); |
| 193 | |
| 194 | HostId hostId = HostId.hostId(macAddr); |
| 195 | hostProvider.hostDetected(hostId, hostDesc, false); |
| 196 | } |
| 197 | |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 198 | /** |
| 199 | * Processes port removal event. |
| 200 | * Once a port removal event is detected, it tries to look for a host |
| 201 | * instance through host provider by giving connect point information, |
| 202 | * and vanishes it. |
| 203 | * |
| 204 | * @param port port object used in ONOS |
| 205 | */ |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 206 | private void processPortRemoved(Port port) { |
| 207 | ConnectPoint connectPoint = new ConnectPoint(port.element().id(), port.number()); |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 208 | hostService.getConnectedHosts(connectPoint) |
| 209 | .forEach(host -> hostProvider.hostVanished(host.id())); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 210 | } |
| 211 | |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 212 | /** |
| 213 | * An internal device listener which listens the port events generated from |
| 214 | * OVS integration bridge. |
| 215 | */ |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 216 | private class InternalDeviceListener implements DeviceListener { |
| 217 | |
| 218 | @Override |
| 219 | public boolean isRelevant(DeviceEvent event) { |
| 220 | Device device = event.subject(); |
| 221 | if (!mastershipService.isLocalMaster(device.id())) { |
| 222 | // do not allow to proceed without mastership |
| 223 | return false; |
| 224 | } |
| 225 | Port port = event.port(); |
| 226 | if (port == null) { |
| 227 | return false; |
| 228 | } |
| 229 | String portName = port.annotations().value(PORT_NAME); |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 230 | |
| 231 | return !Strings.isNullOrEmpty(portName) && |
| 232 | portName.startsWith(PORT_NAME_PREFIX_VM); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 233 | } |
| 234 | |
| 235 | @Override |
| 236 | public void event(DeviceEvent event) { |
| 237 | switch (event.type()) { |
| 238 | case PORT_UPDATED: |
| 239 | if (!event.port().isEnabled()) { |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 240 | portRemovedHelper(deviceEventExecutor, event); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 241 | } else if (event.port().isEnabled()) { |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 242 | portAddedHelper(deviceEventExecutor, event); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 243 | } |
| 244 | break; |
| 245 | case PORT_ADDED: |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 246 | portAddedHelper(deviceEventExecutor, event); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 247 | break; |
Hyunsun Moon | b7a9cd2 | 2017-02-24 11:12:53 +0900 | [diff] [blame] | 248 | case PORT_REMOVED: |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 249 | portRemovedHelper(deviceEventExecutor, event); |
Ray Milkey | d6a67c3 | 2018-02-02 10:30:35 -0800 | [diff] [blame] | 250 | break; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 251 | default: |
| 252 | break; |
| 253 | } |
| 254 | } |
| 255 | } |
| 256 | |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 257 | /** |
| 258 | * A helper method which logs the port addition event and performs port |
| 259 | * addition action. |
| 260 | * |
| 261 | * @param executor device executor service |
| 262 | * @param event device event |
| 263 | */ |
| 264 | private void portAddedHelper(ExecutorService executor, DeviceEvent event) { |
| 265 | executor.execute(() -> { |
| 266 | log.debug("Instance port {} is detected from {}", |
| 267 | event.port().annotations().value(PORT_NAME), |
| 268 | event.subject().id()); |
| 269 | processPortAdded(event.port()); |
| 270 | }); |
| 271 | } |
| 272 | |
| 273 | /** |
| 274 | * A helper method which logs the port removal event and performs port |
| 275 | * removal action. |
| 276 | * |
| 277 | * @param executor device executor service |
| 278 | * @param event device event |
| 279 | */ |
| 280 | private void portRemovedHelper(ExecutorService executor, DeviceEvent event) { |
| 281 | executor.execute(() -> { |
| 282 | log.debug("Instance port {} is removed from {}", |
| 283 | event.port().annotations().value(PORT_NAME), |
| 284 | event.subject().id()); |
| 285 | processPortRemoved(event.port()); |
| 286 | }); |
| 287 | } |
| 288 | |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 289 | private class InternalOpenstackNodeListener implements OpenstackNodeListener { |
| 290 | |
| 291 | @Override |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 292 | public boolean isRelevant(OpenstackNodeEvent event) { |
| 293 | // do not allow to proceed without mastership |
| 294 | Device device = deviceService.getDevice(event.subject().intgBridge()); |
Jian Li | 7ddea78 | 2018-03-30 11:17:42 +0900 | [diff] [blame^] | 295 | if (device == null) { |
| 296 | return false; |
| 297 | } |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 298 | return mastershipService.isLocalMaster(device.id()); |
| 299 | } |
| 300 | |
| 301 | @Override |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 302 | public void event(OpenstackNodeEvent event) { |
| 303 | OpenstackNode osNode = event.subject(); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 304 | |
| 305 | switch (event.type()) { |
Hyunsun Moon | 0d45736 | 2017-06-27 17:19:41 +0900 | [diff] [blame] | 306 | case OPENSTACK_NODE_COMPLETE: |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 307 | deviceEventExecutor.execute(() -> { |
| 308 | log.info("COMPLETE node {} is detected", osNode.hostname()); |
| 309 | processCompleteNode(event.subject()); |
| 310 | }); |
| 311 | break; |
Hyunsun Moon | 0d45736 | 2017-06-27 17:19:41 +0900 | [diff] [blame] | 312 | case OPENSTACK_NODE_INCOMPLETE: |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 313 | log.warn("{} is changed to INCOMPLETE state", osNode); |
| 314 | break; |
Hyunsun Moon | 0d45736 | 2017-06-27 17:19:41 +0900 | [diff] [blame] | 315 | case OPENSTACK_NODE_CREATED: |
| 316 | case OPENSTACK_NODE_UPDATED: |
| 317 | case OPENSTACK_NODE_REMOVED: |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 318 | // not reacts to the events other than complete and incomplete states |
| 319 | break; |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 320 | default: |
Jian Li | 9d676fb | 2018-03-02 15:25:36 +0900 | [diff] [blame] | 321 | log.warn("Unsupported openstack node event type"); |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 322 | break; |
| 323 | } |
| 324 | } |
| 325 | |
| 326 | private void processCompleteNode(OpenstackNode osNode) { |
Hyunsun Moon | 0d45736 | 2017-06-27 17:19:41 +0900 | [diff] [blame] | 327 | deviceService.getPorts(osNode.intgBridge()).stream() |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 328 | .filter(port -> port.annotations().value(PORT_NAME) |
| 329 | .startsWith(PORT_NAME_PREFIX_VM) && |
| 330 | port.isEnabled()) |
| 331 | .forEach(port -> { |
| 332 | log.debug("Instance port {} is detected from {}", |
| 333 | port.annotations().value(PORT_NAME), |
| 334 | osNode.hostname()); |
| 335 | processPortAdded(port); |
| 336 | }); |
| 337 | |
| 338 | Tools.stream(hostService.getHosts()) |
| 339 | .filter(host -> deviceService.getPort( |
| 340 | host.location().deviceId(), |
| 341 | host.location().port()) == null) |
| 342 | .forEach(host -> { |
| 343 | log.info("Remove stale host {}", host.id()); |
| 344 | hostProvider.hostVanished(host.id()); |
| 345 | }); |
| 346 | } |
| 347 | } |
| 348 | } |