Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019-present Open Networking Foundation |
| 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.collect.ImmutableSet; |
| 19 | import org.onlab.packet.Ethernet; |
| 20 | import org.onlab.packet.IPv4; |
| 21 | import org.onlab.packet.IpAddress; |
| 22 | import org.onlab.packet.VlanId; |
| 23 | import org.onosproject.cfg.ComponentConfigService; |
| 24 | import org.onosproject.cfg.ConfigProperty; |
| 25 | import org.onosproject.cluster.ClusterService; |
| 26 | import org.onosproject.cluster.LeadershipService; |
| 27 | import org.onosproject.cluster.NodeId; |
| 28 | import org.onosproject.core.ApplicationId; |
| 29 | import org.onosproject.core.CoreService; |
| 30 | import org.onosproject.mastership.MastershipService; |
| 31 | import org.onosproject.net.Device; |
| 32 | import org.onosproject.net.PortNumber; |
| 33 | import org.onosproject.net.device.DeviceService; |
| 34 | import org.onosproject.net.driver.DriverService; |
| 35 | import org.onosproject.net.flow.DefaultTrafficSelector; |
| 36 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 37 | import org.onosproject.net.flow.TrafficSelector; |
| 38 | import org.onosproject.net.flow.TrafficTreatment; |
| 39 | import org.onosproject.openstacknetworking.api.OpenstackFlowRuleService; |
| 40 | import org.onosproject.openstacknetworking.api.OpenstackNetwork.Type; |
| 41 | import org.onosproject.openstacknetworking.api.OpenstackNetworkService; |
| 42 | import org.onosproject.openstacknetworking.api.OpenstackRouterEvent; |
| 43 | import org.onosproject.openstacknetworking.api.OpenstackRouterListener; |
| 44 | import org.onosproject.openstacknetworking.api.OpenstackRouterService; |
| 45 | import org.onosproject.openstacknode.api.OpenstackNode; |
| 46 | import org.onosproject.openstacknode.api.OpenstackNodeEvent; |
| 47 | import org.onosproject.openstacknode.api.OpenstackNodeListener; |
| 48 | import org.onosproject.openstacknode.api.OpenstackNodeService; |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 49 | import org.openstack4j.model.network.Network; |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 50 | import org.openstack4j.model.network.Router; |
| 51 | import org.openstack4j.model.network.RouterInterface; |
| 52 | import org.openstack4j.model.network.Subnet; |
| 53 | import org.osgi.service.component.annotations.Activate; |
| 54 | import org.osgi.service.component.annotations.Component; |
| 55 | import org.osgi.service.component.annotations.Deactivate; |
| 56 | import org.osgi.service.component.annotations.Reference; |
| 57 | import org.osgi.service.component.annotations.ReferenceCardinality; |
| 58 | import org.slf4j.Logger; |
| 59 | |
| 60 | import java.util.Objects; |
| 61 | import java.util.Set; |
| 62 | import java.util.concurrent.ExecutorService; |
| 63 | import java.util.stream.Collectors; |
| 64 | |
| 65 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
| 66 | import static org.onlab.packet.ICMP.CODE_ECHO_REQEUST; |
| 67 | import static org.onlab.packet.ICMP.TYPE_ECHO_REPLY; |
| 68 | import static org.onlab.packet.ICMP.TYPE_ECHO_REQUEST; |
| 69 | import static org.onlab.util.Tools.groupedThreads; |
| 70 | import static org.onosproject.openstacknetworking.api.Constants.DEFAULT_GATEWAY_MAC; |
| 71 | import static org.onosproject.openstacknetworking.api.Constants.OPENSTACK_NETWORKING_APP_ID; |
| 72 | import static org.onosproject.openstacknetworking.api.Constants.PRIORITY_ICMP_RULE; |
| 73 | import static org.onosproject.openstacknetworking.api.Constants.ROUTING_TABLE; |
| 74 | import static org.onosproject.openstacknetworking.impl.OsgiPropertyConstants.USE_STATEFUL_SNAT; |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 75 | import static org.onosproject.openstacknetworking.util.OpenstackNetworkingUtil.getExternalIp; |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 76 | import static org.onosproject.openstacknetworking.util.OpenstackNetworkingUtil.getPropertyValueAsBoolean; |
| 77 | import static org.onosproject.openstacknetworking.util.RulePopulatorUtil.NXM_NX_IP_TTL; |
| 78 | import static org.onosproject.openstacknetworking.util.RulePopulatorUtil.NXM_OF_ICMP_TYPE; |
| 79 | import static org.onosproject.openstacknetworking.util.RulePopulatorUtil.buildLoadExtension; |
| 80 | import static org.onosproject.openstacknetworking.util.RulePopulatorUtil.buildMoveEthSrcToDstExtension; |
| 81 | import static org.onosproject.openstacknetworking.util.RulePopulatorUtil.buildMoveIpSrcToDstExtension; |
| 82 | import static org.onosproject.openstacknode.api.OpenstackNode.NodeType.COMPUTE; |
| 83 | import static org.slf4j.LoggerFactory.getLogger; |
| 84 | |
| 85 | /** |
| 86 | * Populates the ICMP flow rules for providing connectivity with gateways. |
| 87 | */ |
| 88 | @Component(immediate = true) |
| 89 | public class OpenstackSwitchingIcmpHandler { |
| 90 | |
| 91 | private final Logger log = getLogger(getClass()); |
| 92 | |
| 93 | private static final int DEFAULT_TTL = 0xff; |
| 94 | |
| 95 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 96 | protected CoreService coreService; |
| 97 | |
| 98 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 99 | protected MastershipService mastershipService; |
| 100 | |
| 101 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 102 | protected DeviceService deviceService; |
| 103 | |
| 104 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 105 | protected DriverService driverService; |
| 106 | |
| 107 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 108 | protected ClusterService clusterService; |
| 109 | |
| 110 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 111 | protected ComponentConfigService configService; |
| 112 | |
| 113 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 114 | protected LeadershipService leadershipService; |
| 115 | |
| 116 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 117 | protected OpenstackNodeService osNodeService; |
| 118 | |
| 119 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 120 | protected OpenstackNetworkService osNetworkService; |
| 121 | |
| 122 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 123 | protected OpenstackFlowRuleService osFlowRuleService; |
| 124 | |
| 125 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 126 | protected OpenstackRouterService osRouterService; |
| 127 | |
| 128 | private final ExecutorService eventExecutor = newSingleThreadExecutor( |
| 129 | groupedThreads(this.getClass().getSimpleName(), "event-handler")); |
| 130 | private final OpenstackRouterListener osRouterListener = new InternalRouterEventListener(); |
| 131 | private final OpenstackNodeListener osNodeListener = new InternalNodeEventListener(); |
| 132 | |
| 133 | private ApplicationId appId; |
| 134 | private NodeId localNodeId; |
| 135 | |
| 136 | @Activate |
| 137 | protected void activate() { |
| 138 | appId = coreService.registerApplication(OPENSTACK_NETWORKING_APP_ID); |
| 139 | localNodeId = clusterService.getLocalNode().id(); |
| 140 | osRouterService.addListener(osRouterListener); |
| 141 | osNodeService.addListener(osNodeListener); |
| 142 | |
| 143 | log.info("Started"); |
| 144 | } |
| 145 | |
| 146 | @Deactivate |
| 147 | protected void deactivate() { |
| 148 | osRouterService.removeListener(osRouterListener); |
| 149 | osNodeService.removeListener(osNodeListener); |
| 150 | eventExecutor.shutdown(); |
| 151 | |
| 152 | log.info("Stopped"); |
| 153 | } |
| 154 | |
| 155 | private boolean getStatefulSnatFlag() { |
| 156 | Set<ConfigProperty> properties = |
| 157 | configService.getProperties(OpenstackRoutingSnatHandler.class.getName()); |
| 158 | return getPropertyValueAsBoolean(properties, USE_STATEFUL_SNAT); |
| 159 | } |
| 160 | |
| 161 | private void processRouterIntfEvent(Router osRouter, RouterInterface routerIface, boolean install) { |
| 162 | if (!getStatefulSnatFlag()) { |
| 163 | return; |
| 164 | } |
| 165 | |
| 166 | Subnet osSubnet = osNetworkService.subnet(routerIface.getSubnetId()); |
| 167 | Type netType = osNetworkService.networkType(osSubnet.getNetworkId()); |
| 168 | String segId = osNetworkService.segmentId(osSubnet.getNetworkId()); |
| 169 | IpAddress gatewayIp = IpAddress.valueOf(osSubnet.getGateway()); |
| 170 | Set<Subnet> routableSubnets = routableSubnets(osRouter, osSubnet.getId()); |
| 171 | |
| 172 | osNodeService.completeNodes(COMPUTE).stream() |
| 173 | .filter(cNode -> cNode.dataIp() != null) |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 174 | .forEach(cNode -> { |
| 175 | setRoutableSubnetsIcmpRules(cNode, segId, osSubnet, |
| 176 | routableSubnets, gatewayIp, netType, install); |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 177 | }); |
| 178 | } |
| 179 | |
| 180 | private void processRouteGatewayEvent(Router osRouter, boolean install) { |
| 181 | if (!getStatefulSnatFlag()) { |
| 182 | return; |
| 183 | } |
| 184 | |
| 185 | osNodeService.completeNodes(COMPUTE).stream() |
| 186 | .filter(cNode -> cNode.dataIp() != null) |
| 187 | .forEach(cNode -> { |
| 188 | setExtGatewayIcmpReplyRules(cNode, osRouter, install); |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 189 | }); |
| 190 | } |
| 191 | |
| 192 | private void setExtGatewayIcmpReplyRules(OpenstackNode osNode, |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 193 | Router osRouter, |
| 194 | boolean install) { |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 195 | |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 196 | IpAddress natAddress = getExternalIp(osRouter, osNetworkService); |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 197 | if (natAddress == null) { |
| 198 | return; |
| 199 | } |
| 200 | |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 201 | setGatewayIcmpReplyRule(osNode, null, natAddress, null, install); |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 202 | } |
| 203 | |
| 204 | private void setRoutableSubnetsIcmpRules(OpenstackNode osNode, |
| 205 | String segmentId, |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 206 | Subnet updatedSubnet, |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 207 | Set<Subnet> routableSubnets, |
| 208 | IpAddress gatewayIp, |
| 209 | Type networkType, |
| 210 | boolean install) { |
| 211 | setGatewayIcmpReplyRule(osNode, segmentId, gatewayIp, networkType, install); |
| 212 | |
| 213 | routableSubnets.forEach(subnet -> { |
| 214 | setGatewayIcmpReplyRule(osNode, segmentId, |
| 215 | IpAddress.valueOf(subnet.getGateway()), networkType, install); |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 216 | |
| 217 | Network network = osNetworkService.network(subnet.getNetworkId()); |
| 218 | |
| 219 | setGatewayIcmpReplyRule(osNode, network.getProviderSegID(), |
| 220 | IpAddress.valueOf(updatedSubnet.getGateway()), networkType, install); |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 221 | }); |
| 222 | } |
| 223 | |
| 224 | private Set<Subnet> routableSubnets(Router osRouter, String osSubnetId) { |
| 225 | Set<Subnet> osSubnets = osRouterService.routerInterfaces(osRouter.getId()) |
| 226 | .stream() |
| 227 | .filter(iface -> !Objects.equals(iface.getSubnetId(), osSubnetId)) |
| 228 | .map(iface -> osNetworkService.subnet(iface.getSubnetId())) |
| 229 | .collect(Collectors.toSet()); |
| 230 | return ImmutableSet.copyOf(osSubnets); |
| 231 | } |
| 232 | |
| 233 | private void setGatewayIcmpReplyRule(OpenstackNode osNode, |
| 234 | String segmentId, |
| 235 | IpAddress gatewayIp, |
| 236 | Type networkType, |
| 237 | boolean install) { |
| 238 | TrafficSelector.Builder sBuilder = DefaultTrafficSelector.builder() |
| 239 | .matchEthType(Ethernet.TYPE_IPV4) |
| 240 | .matchIPProtocol(IPv4.PROTOCOL_ICMP) |
| 241 | .matchIcmpType(TYPE_ECHO_REQUEST) |
| 242 | .matchIcmpCode(CODE_ECHO_REQEUST) |
| 243 | .matchIPDst(gatewayIp.getIp4Address().toIpPrefix()); |
| 244 | |
Jian Li | a299519 | 2019-04-02 14:13:04 +0900 | [diff] [blame] | 245 | if (segmentId != null) { |
| 246 | switch (networkType) { |
| 247 | case VXLAN: |
| 248 | case GRE: |
| 249 | case GENEVE: |
| 250 | sBuilder.matchTunnelId(Long.parseLong(segmentId)); |
| 251 | break; |
| 252 | case VLAN: |
| 253 | sBuilder.matchVlanId(VlanId.vlanId(segmentId)); |
| 254 | break; |
| 255 | default: |
| 256 | break; |
| 257 | } |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | Device device = deviceService.getDevice(osNode.intgBridge()); |
| 261 | TrafficTreatment.Builder tBuilder = DefaultTrafficTreatment.builder() |
| 262 | .extension(buildMoveEthSrcToDstExtension(device), device.id()) |
| 263 | .extension(buildMoveIpSrcToDstExtension(device), device.id()) |
| 264 | .extension(buildLoadExtension(device, NXM_NX_IP_TTL, DEFAULT_TTL), device.id()) |
| 265 | .extension(buildLoadExtension(device, NXM_OF_ICMP_TYPE, TYPE_ECHO_REPLY), device.id()) |
| 266 | .setIpSrc(gatewayIp) |
| 267 | .setEthSrc(DEFAULT_GATEWAY_MAC) |
| 268 | .setOutput(PortNumber.IN_PORT); |
| 269 | |
| 270 | osFlowRuleService.setRule( |
| 271 | appId, |
| 272 | osNode.intgBridge(), |
| 273 | sBuilder.build(), |
| 274 | tBuilder.build(), |
| 275 | PRIORITY_ICMP_RULE, |
| 276 | ROUTING_TABLE, |
| 277 | install); |
| 278 | } |
| 279 | |
| 280 | private class InternalRouterEventListener implements OpenstackRouterListener { |
| 281 | private boolean isRelevantHelper() { |
| 282 | return Objects.equals(localNodeId, leadershipService.getLeader(appId.name())); |
| 283 | } |
| 284 | |
| 285 | @Override |
| 286 | public void event(OpenstackRouterEvent event) { |
| 287 | switch (event.type()) { |
| 288 | case OPENSTACK_ROUTER_INTERFACE_ADDED: |
| 289 | eventExecutor.execute(() -> processRouterIntfCreation(event)); |
| 290 | break; |
| 291 | case OPENSTACK_ROUTER_INTERFACE_REMOVED: |
| 292 | eventExecutor.execute(() -> processRouterIntfRemoval(event)); |
| 293 | break; |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 294 | case OPENSTACK_ROUTER_GATEWAY_ADDED: |
| 295 | eventExecutor.execute(() -> processRouterGatewayAddition(event)); |
| 296 | break; |
| 297 | case OPENSTACK_ROUTER_GATEWAY_REMOVED: |
| 298 | eventExecutor.execute(() -> processRouterGatewayRemoval(event)); |
| 299 | break; |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 300 | default: |
| 301 | // do nothing for the other events |
| 302 | break; |
| 303 | } |
| 304 | } |
| 305 | |
| 306 | private void processRouterIntfCreation(OpenstackRouterEvent event) { |
| 307 | if (!isRelevantHelper()) { |
| 308 | return; |
| 309 | } |
| 310 | |
| 311 | log.debug("Router interface {} added to router {}", |
| 312 | event.routerIface().getPortId(), |
| 313 | event.routerIface().getId()); |
| 314 | |
| 315 | processRouterIntfEvent(event.subject(), event.routerIface(), true); |
| 316 | } |
| 317 | |
| 318 | private void processRouterIntfRemoval(OpenstackRouterEvent event) { |
| 319 | if (!isRelevantHelper()) { |
| 320 | return; |
| 321 | } |
| 322 | |
| 323 | log.debug("Router interface {} removed from router {}", |
| 324 | event.routerIface().getPortId(), |
| 325 | event.routerIface().getId()); |
| 326 | |
| 327 | processRouterIntfEvent(event.subject(), event.routerIface(), false); |
| 328 | } |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 329 | |
| 330 | private void processRouterGatewayAddition(OpenstackRouterEvent event) { |
| 331 | if (!isRelevantHelper()) { |
| 332 | return; |
| 333 | } |
| 334 | |
| 335 | log.debug("Router external gateway {} added", |
| 336 | event.externalGateway().getNetworkId()); |
| 337 | |
| 338 | processRouteGatewayEvent(event.subject(), true); |
| 339 | } |
| 340 | |
| 341 | private void processRouterGatewayRemoval(OpenstackRouterEvent event) { |
| 342 | if (!isRelevantHelper()) { |
| 343 | return; |
| 344 | } |
| 345 | |
| 346 | log.debug("Router external gateway {} removed", |
| 347 | event.externalGateway().getNetworkId()); |
| 348 | |
| 349 | processRouteGatewayEvent(event.subject(), false); |
| 350 | } |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 351 | } |
| 352 | |
| 353 | private class InternalNodeEventListener implements OpenstackNodeListener { |
| 354 | |
| 355 | private boolean isRelevantHelper() { |
| 356 | return Objects.equals(localNodeId, leadershipService.getLeader(appId.name())); |
| 357 | } |
| 358 | |
| 359 | @Override |
| 360 | public void event(OpenstackNodeEvent event) { |
| 361 | OpenstackNode osNode = event.subject(); |
| 362 | switch (event.type()) { |
| 363 | case OPENSTACK_NODE_COMPLETE: |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 364 | case OPENSTACK_NODE_UPDATED: |
| 365 | case OPENSTACK_NODE_REMOVED: |
| 366 | eventExecutor.execute(() -> { |
| 367 | if (!isRelevantHelper()) { |
| 368 | return; |
| 369 | } |
| 370 | reconfigureRouters(osNode); |
| 371 | }); |
| 372 | break; |
Jian Li | 238552d | 2019-09-24 22:32:02 +0900 | [diff] [blame] | 373 | case OPENSTACK_NODE_INCOMPLETE: |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 374 | default: |
| 375 | break; |
| 376 | } |
| 377 | } |
| 378 | |
| 379 | private void reconfigureRouters(OpenstackNode osNode) { |
| 380 | osRouterService.routers().forEach(osRouter -> { |
| 381 | osRouterService.routerInterfaces(osRouter.getId()).forEach(iface -> { |
| 382 | processRouterIntfEvent(osRouter, iface, true); |
| 383 | }); |
Jian Li | 4f3f75a | 2019-04-03 12:41:30 +0900 | [diff] [blame] | 384 | processRouteGatewayEvent(osRouter, true); |
Jian Li | 2525721 | 2019-03-26 13:31:14 +0900 | [diff] [blame] | 385 | }); |
| 386 | log.info("Reconfigure routers for {}", osNode.hostname()); |
| 387 | } |
| 388 | } |
| 389 | } |