| /* |
| * Copyright 2016-present Open Networking Laboratory |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.openstacknetworking.impl; |
| |
| import com.google.common.base.Strings; |
| import com.google.common.collect.ImmutableSet; |
| import org.apache.felix.scr.annotations.Activate; |
| import org.apache.felix.scr.annotations.Component; |
| import org.apache.felix.scr.annotations.Deactivate; |
| import org.apache.felix.scr.annotations.Reference; |
| import org.apache.felix.scr.annotations.ReferenceCardinality; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.packet.IPv4; |
| import org.onlab.packet.IpAddress; |
| import org.onlab.packet.IpPrefix; |
| import org.onosproject.cluster.ClusterService; |
| import org.onosproject.cluster.LeadershipService; |
| import org.onosproject.cluster.NodeId; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.core.GroupId; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.PortNumber; |
| import org.onosproject.net.flow.DefaultTrafficSelector; |
| import org.onosproject.net.flow.DefaultTrafficTreatment; |
| import org.onosproject.net.flow.TrafficSelector; |
| import org.onosproject.net.flow.TrafficTreatment; |
| import org.onosproject.net.flowobjective.FlowObjectiveService; |
| import org.onosproject.net.flowobjective.ForwardingObjective; |
| import org.onosproject.openstacknetworking.api.Constants; |
| import org.onosproject.openstacknetworking.api.OpenstackNetworkService; |
| import org.onosproject.openstacknetworking.api.OpenstackRouterEvent; |
| import org.onosproject.openstacknetworking.api.OpenstackRouterListener; |
| import org.onosproject.openstacknetworking.api.OpenstackRouterService; |
| import org.onosproject.openstacknode.OpenstackNode; |
| import org.onosproject.openstacknode.OpenstackNodeEvent; |
| import org.onosproject.openstacknode.OpenstackNodeListener; |
| import org.onosproject.openstacknode.OpenstackNodeService; |
| import org.onosproject.scalablegateway.api.ScalableGatewayService; |
| import org.openstack4j.model.network.ExternalGateway; |
| import org.openstack4j.model.network.Network; |
| import org.openstack4j.model.network.Router; |
| import org.openstack4j.model.network.RouterInterface; |
| import org.openstack4j.model.network.Subnet; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.util.Objects; |
| import java.util.Set; |
| import java.util.concurrent.ExecutorService; |
| import java.util.stream.Collectors; |
| |
| import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| import static org.onlab.util.Tools.groupedThreads; |
| import static org.onosproject.openstacknetworking.api.Constants.*; |
| import static org.onosproject.openstacknode.OpenstackNodeService.NodeType.COMPUTE; |
| |
| /** |
| * Handles OpenStack router events. |
| */ |
| @Component(immediate = true) |
| public class OpenstackRoutingHandler { |
| |
| private final Logger log = LoggerFactory.getLogger(getClass()); |
| |
| private static final String MSG_ENABLED = "Enabled "; |
| private static final String MSG_DISABLED = "Disabled "; |
| private static final String ERR_SET_FLOWS = "Failed to set flows for router %s:"; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected CoreService coreService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected LeadershipService leadershipService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected ClusterService clusterService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected FlowObjectiveService flowObjectiveService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected OpenstackNodeService osNodeService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected ScalableGatewayService gatewayService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected OpenstackNetworkService osNetworkService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected OpenstackRouterService osRouterService; |
| |
| private final ExecutorService eventExecutor = newSingleThreadScheduledExecutor( |
| groupedThreads(this.getClass().getSimpleName(), "event-handler", log)); |
| private final OpenstackNodeListener osNodeListener = new InternalNodeEventListener(); |
| private final OpenstackRouterListener osRouterListener = new InternalRouterEventListener(); |
| |
| private ApplicationId appId; |
| private NodeId localNodeId; |
| |
| @Activate |
| protected void activate() { |
| appId = coreService.registerApplication(OPENSTACK_NETWORKING_APP_ID); |
| localNodeId = clusterService.getLocalNode().id(); |
| leadershipService.runForLeadership(appId.name()); |
| osNodeService.addListener(osNodeListener); |
| osRouterService.addListener(osRouterListener); |
| |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| protected void deactivate() { |
| osRouterService.removeListener(osRouterListener); |
| osNodeService.removeListener(osNodeListener); |
| leadershipService.withdraw(appId.name()); |
| eventExecutor.shutdown(); |
| |
| log.info("Stopped"); |
| } |
| |
| private void routerUpdated(Router osRouter) { |
| ExternalGateway exGateway = osRouter.getExternalGatewayInfo(); |
| if (exGateway == null) { |
| osRouterService.routerInterfaces(osRouter.getId()).forEach(iface -> { |
| setSourceNat(iface, false); |
| }); |
| } else { |
| osRouterService.routerInterfaces(osRouter.getId()).forEach(iface -> { |
| setSourceNat(iface, exGateway.isEnableSnat()); |
| }); |
| } |
| } |
| |
| private void routerIfaceAdded(Router osRouter, RouterInterface osRouterIface) { |
| Subnet osSubnet = osNetworkService.subnet(osRouterIface.getSubnetId()); |
| if (osSubnet == null) { |
| final String error = String.format( |
| ERR_SET_FLOWS + "subnet %s does not exist", |
| osRouterIface.getId(), |
| osRouterIface.getSubnetId()); |
| throw new IllegalStateException(error); |
| } |
| |
| setInternalRoutes(osRouter, osSubnet, true); |
| setGatewayIcmp(osSubnet, true); |
| ExternalGateway exGateway = osRouter.getExternalGatewayInfo(); |
| if (exGateway != null && exGateway.isEnableSnat()) { |
| setSourceNat(osRouterIface, true); |
| } |
| |
| log.info("Connected subnet({}) to {}", osSubnet.getCidr(), osRouter.getName()); |
| } |
| |
| private void routerIfaceRemoved(Router osRouter, RouterInterface osRouterIface) { |
| Subnet osSubnet = osNetworkService.subnet(osRouterIface.getSubnetId()); |
| if (osSubnet == null) { |
| final String error = String.format( |
| ERR_SET_FLOWS + "subnet %s does not exist", |
| osRouterIface.getId(), |
| osRouterIface.getSubnetId()); |
| throw new IllegalStateException(error); |
| } |
| |
| setInternalRoutes(osRouter, osSubnet, false); |
| setGatewayIcmp(osSubnet, false); |
| ExternalGateway exGateway = osRouter.getExternalGatewayInfo(); |
| if (exGateway != null && exGateway.isEnableSnat()) { |
| setSourceNat(osRouterIface, false); |
| } |
| |
| log.info("Disconnected subnet({}) from {}", osSubnet.getCidr(), osRouter.getName()); |
| } |
| |
| private void setSourceNat(RouterInterface routerIface, boolean install) { |
| Subnet osSubnet = osNetworkService.subnet(routerIface.getSubnetId()); |
| Network osNet = osNetworkService.network(osSubnet.getNetworkId()); |
| |
| osNodeService.completeNodes().stream() |
| .filter(osNode -> osNode.type() == COMPUTE) |
| .forEach(osNode -> { |
| setRulesToGateway( |
| osNode.intBridge(), |
| gatewayService.getGatewayGroupId(osNode.intBridge()), |
| Long.valueOf(osNet.getProviderSegID()), |
| IpPrefix.valueOf(osSubnet.getCidr()), |
| install); |
| }); |
| |
| // take the first outgoing packet to controller for source NAT |
| gatewayService.getGatewayDeviceIds() |
| .forEach(gwDeviceId -> setRulesToController( |
| gwDeviceId, |
| Long.valueOf(osNet.getProviderSegID()), |
| IpPrefix.valueOf(osSubnet.getCidr()), |
| install)); |
| |
| final String updateStr = install ? MSG_ENABLED : MSG_DISABLED; |
| log.info(updateStr + "external access for subnet({})", osSubnet.getCidr()); |
| } |
| |
| private void setGatewayIcmp(Subnet osSubnet, boolean install) { |
| if (Strings.isNullOrEmpty(osSubnet.getGateway())) { |
| // do nothing if no gateway is set |
| return; |
| } |
| |
| // take ICMP request to a subnet gateway through gateway node group |
| Network network = osNetworkService.network(osSubnet.getNetworkId()); |
| osNodeService.completeNodes().stream() |
| .filter(osNode -> osNode.type() == COMPUTE) |
| .forEach(osNode -> setRulesToGatewayWithDstIp( |
| osNode.intBridge(), |
| gatewayService.getGatewayGroupId(osNode.intBridge()), |
| Long.valueOf(network.getProviderSegID()), |
| IpAddress.valueOf(osSubnet.getGateway()), |
| install)); |
| |
| IpAddress gatewayIp = IpAddress.valueOf(osSubnet.getGateway()); |
| gatewayService.getGatewayDeviceIds() |
| .forEach(gwDeviceId -> setGatewayIcmpRule( |
| gatewayIp, |
| gwDeviceId, |
| install |
| )); |
| |
| final String updateStr = install ? MSG_ENABLED : MSG_DISABLED; |
| log.debug(updateStr + "ICMP to {}", osSubnet.getGateway()); |
| } |
| |
| private void setInternalRoutes(Router osRouter, Subnet updatedSubnet, boolean install) { |
| Set<Subnet> routableSubnets = routableSubnets(osRouter, updatedSubnet.getId()); |
| Long updatedVni = getVni(updatedSubnet); |
| |
| // installs rule from/to my subnet intentionally to fix ICMP failure |
| // to my subnet gateway if no external gateway added to the router |
| osNodeService.completeNodes().stream() |
| .filter(osNode -> osNode.type() == COMPUTE) |
| .forEach(osNode -> { |
| setInternalRouterRules( |
| osNode.intBridge(), |
| updatedVni, |
| updatedVni, |
| IpPrefix.valueOf(updatedSubnet.getCidr()), |
| IpPrefix.valueOf(updatedSubnet.getCidr()), |
| install |
| ); |
| |
| routableSubnets.forEach(subnet -> { |
| setInternalRouterRules( |
| osNode.intBridge(), |
| updatedVni, |
| getVni(subnet), |
| IpPrefix.valueOf(updatedSubnet.getCidr()), |
| IpPrefix.valueOf(subnet.getCidr()), |
| install |
| ); |
| setInternalRouterRules( |
| osNode.intBridge(), |
| getVni(subnet), |
| updatedVni, |
| IpPrefix.valueOf(subnet.getCidr()), |
| IpPrefix.valueOf(updatedSubnet.getCidr()), |
| install |
| ); |
| }); |
| }); |
| |
| final String updateStr = install ? MSG_ENABLED : MSG_DISABLED; |
| routableSubnets.forEach(subnet -> log.debug( |
| updateStr + "route between subnet:{} and subnet:{}", |
| subnet.getCidr(), |
| updatedSubnet.getCidr())); |
| } |
| |
| private Set<Subnet> routableSubnets(Router osRouter, String osSubnetId) { |
| Set<Subnet> osSubnets = osRouterService.routerInterfaces(osRouter.getId()) |
| .stream() |
| .filter(iface -> !Objects.equals(iface.getSubnetId(), osSubnetId)) |
| .map(iface -> osNetworkService.subnet(iface.getSubnetId())) |
| .collect(Collectors.toSet()); |
| return ImmutableSet.copyOf(osSubnets); |
| } |
| |
| private Long getVni(Subnet osSubnet) { |
| return Long.parseLong(osNetworkService.network( |
| osSubnet.getNetworkId()).getProviderSegID()); |
| } |
| |
| private void setGatewayIcmpRule(IpAddress gatewayIp, DeviceId deviceId, boolean install) { |
| TrafficSelector selector = DefaultTrafficSelector.builder() |
| .matchEthType(Ethernet.TYPE_IPV4) |
| .matchIPProtocol(IPv4.PROTOCOL_ICMP) |
| .matchIPDst(gatewayIp.toIpPrefix()) |
| .build(); |
| |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .setOutput(PortNumber.CONTROLLER) |
| .build(); |
| |
| RulePopulatorUtil.setRule( |
| flowObjectiveService, |
| appId, |
| deviceId, |
| selector, |
| treatment, |
| ForwardingObjective.Flag.VERSATILE, |
| PRIORITY_ICMP_RULE, |
| install); |
| } |
| |
| private void setInternalRouterRules(DeviceId deviceId, Long srcVni, Long dstVni, |
| IpPrefix srcSubnet, IpPrefix dstSubnet, boolean install) { |
| TrafficSelector selector = DefaultTrafficSelector.builder() |
| .matchEthType(Ethernet.TYPE_IPV4) |
| .matchTunnelId(srcVni) |
| .matchIPSrc(srcSubnet) |
| .matchIPDst(dstSubnet) |
| .build(); |
| |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .setTunnelId(dstVni) |
| .build(); |
| |
| RulePopulatorUtil.setRule( |
| flowObjectiveService, |
| appId, |
| deviceId, |
| selector, |
| treatment, |
| ForwardingObjective.Flag.SPECIFIC, |
| PRIORITY_INTERNAL_ROUTING_RULE, |
| install); |
| |
| selector = DefaultTrafficSelector.builder() |
| .matchEthType(Ethernet.TYPE_IPV4) |
| .matchTunnelId(dstVni) |
| .matchIPSrc(srcSubnet) |
| .matchIPDst(dstSubnet) |
| .build(); |
| |
| treatment = DefaultTrafficTreatment.builder() |
| .setTunnelId(dstVni) |
| .build(); |
| |
| RulePopulatorUtil.setRule( |
| flowObjectiveService, |
| appId, |
| deviceId, |
| selector, |
| treatment, |
| ForwardingObjective.Flag.SPECIFIC, |
| PRIORITY_INTERNAL_ROUTING_RULE, |
| install); |
| } |
| |
| private void setRulesToGateway(DeviceId deviceId, GroupId groupId, Long vni, |
| IpPrefix srcSubnet, boolean install) { |
| TrafficSelector selector = DefaultTrafficSelector.builder() |
| .matchEthType(Ethernet.TYPE_IPV4) |
| .matchTunnelId(vni) |
| .matchIPSrc(srcSubnet) |
| .matchEthDst(Constants.DEFAULT_GATEWAY_MAC) |
| .build(); |
| |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .group(groupId) |
| .build(); |
| |
| RulePopulatorUtil.setRule( |
| flowObjectiveService, |
| appId, |
| deviceId, |
| selector, |
| treatment, |
| ForwardingObjective.Flag.SPECIFIC, |
| PRIORITY_EXTERNAL_ROUTING_RULE, |
| install); |
| } |
| |
| private void setRulesToController(DeviceId deviceId, Long vni, IpPrefix srcSubnet, boolean install) { |
| TrafficSelector selector = DefaultTrafficSelector.builder() |
| .matchEthType(Ethernet.TYPE_IPV4) |
| .matchTunnelId(vni) |
| .matchIPSrc(srcSubnet) |
| .matchEthDst(Constants.DEFAULT_GATEWAY_MAC) |
| .build(); |
| |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .setOutput(PortNumber.CONTROLLER) |
| .build(); |
| |
| RulePopulatorUtil.setRule( |
| flowObjectiveService, |
| appId, |
| deviceId, |
| selector, |
| treatment, |
| ForwardingObjective.Flag.VERSATILE, |
| PRIORITY_EXTERNAL_ROUTING_RULE, |
| install); |
| } |
| |
| private void setRulesToGatewayWithDstIp(DeviceId deviceId, GroupId groupId, Long vni, |
| IpAddress dstIp, boolean install) { |
| TrafficSelector selector = DefaultTrafficSelector.builder() |
| .matchEthType(Ethernet.TYPE_IPV4) |
| .matchTunnelId(vni) |
| .matchIPDst(dstIp.toIpPrefix()) |
| .build(); |
| |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .group(groupId) |
| .build(); |
| |
| RulePopulatorUtil.setRule( |
| flowObjectiveService, |
| appId, |
| deviceId, |
| selector, |
| treatment, |
| ForwardingObjective.Flag.SPECIFIC, |
| PRIORITY_SWITCHING_RULE, |
| install); |
| } |
| |
| private class InternalRouterEventListener implements OpenstackRouterListener { |
| |
| @Override |
| public boolean isRelevant(OpenstackRouterEvent event) { |
| // do not allow to proceed without leadership |
| NodeId leader = leadershipService.getLeader(appId.name()); |
| return Objects.equals(localNodeId, leader); |
| } |
| |
| // FIXME only one leader in the cluster should process |
| @Override |
| public void event(OpenstackRouterEvent event) { |
| switch (event.type()) { |
| case OPENSTACK_ROUTER_CREATED: |
| log.debug("Router(name:{}, ID:{}) is created", |
| event.subject().getName(), |
| event.subject().getId()); |
| eventExecutor.execute(() -> routerUpdated(event.subject())); |
| break; |
| case OPENSTACK_ROUTER_UPDATED: |
| log.debug("Router(name:{}, ID:{}) is updated", |
| event.subject().getName(), |
| event.subject().getId()); |
| eventExecutor.execute(() -> routerUpdated(event.subject())); |
| break; |
| case OPENSTACK_ROUTER_REMOVED: |
| log.debug("Router(name:{}, ID:{}) is removed", |
| event.subject().getName(), |
| event.subject().getId()); |
| break; |
| case OPENSTACK_ROUTER_INTERFACE_ADDED: |
| log.debug("Router interface {} added to router {}", |
| event.routerIface().getPortId(), |
| event.routerIface().getId()); |
| eventExecutor.execute(() -> routerIfaceAdded( |
| event.subject(), |
| event.routerIface())); |
| break; |
| case OPENSTACK_ROUTER_INTERFACE_UPDATED: |
| log.debug("Router interface {} on {} updated", |
| event.routerIface().getPortId(), |
| event.routerIface().getId()); |
| break; |
| case OPENSTACK_ROUTER_INTERFACE_REMOVED: |
| log.debug("Router interface {} removed from router {}", |
| event.routerIface().getPortId(), |
| event.routerIface().getId()); |
| eventExecutor.execute(() -> routerIfaceRemoved( |
| event.subject(), |
| event.routerIface())); |
| break; |
| case OPENSTACK_ROUTER_GATEWAY_ADDED: |
| case OPENSTACK_ROUTER_GATEWAY_REMOVED: |
| case OPENSTACK_FLOATING_IP_CREATED: |
| case OPENSTACK_FLOATING_IP_UPDATED: |
| case OPENSTACK_FLOATING_IP_REMOVED: |
| case OPENSTACK_FLOATING_IP_ASSOCIATED: |
| case OPENSTACK_FLOATING_IP_DISASSOCIATED: |
| default: |
| // do nothing for the other events |
| break; |
| } |
| } |
| } |
| |
| private class InternalNodeEventListener implements OpenstackNodeListener { |
| |
| @Override |
| public boolean isRelevant(OpenstackNodeEvent event) { |
| // do not allow to proceed without leadership |
| NodeId leader = leadershipService.getLeader(appId.name()); |
| return Objects.equals(localNodeId, leader); |
| } |
| |
| @Override |
| public void event(OpenstackNodeEvent event) { |
| OpenstackNode osNode = event.subject(); |
| |
| switch (event.type()) { |
| case COMPLETE: |
| case INCOMPLETE: |
| eventExecutor.execute(() -> { |
| log.info("COMPLETE node {} detected", osNode.hostname()); |
| reconfigureRouters(); |
| }); |
| break; |
| case INIT: |
| case DEVICE_CREATED: |
| default: |
| break; |
| } |
| } |
| |
| private void reconfigureRouters() { |
| osRouterService.routers().forEach(osRouter -> { |
| routerUpdated(osRouter); |
| osRouterService.routerInterfaces(osRouter.getId()).forEach(iface -> { |
| routerIfaceAdded(osRouter, iface); |
| }); |
| }); |
| } |
| } |
| } |