Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.fwd; |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 17 | |
Jonathan Hart | bc4a793 | 2014-10-21 11:46:00 -0700 | [diff] [blame] | 18 | import static org.slf4j.LoggerFactory.getLogger; |
| 19 | |
| 20 | import java.util.Dictionary; |
| 21 | import java.util.Set; |
| 22 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Activate; |
| 24 | import org.apache.felix.scr.annotations.Component; |
| 25 | import org.apache.felix.scr.annotations.Deactivate; |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Modified; |
| 27 | import org.apache.felix.scr.annotations.Property; |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Reference; |
| 29 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
Jonathan Hart | e8600eb | 2015-01-12 10:30:45 -0800 | [diff] [blame] | 30 | import org.onlab.packet.Ethernet; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 31 | import org.onosproject.core.ApplicationId; |
| 32 | import org.onosproject.core.CoreService; |
| 33 | import org.onosproject.net.Host; |
| 34 | import org.onosproject.net.HostId; |
| 35 | import org.onosproject.net.Path; |
| 36 | import org.onosproject.net.PortNumber; |
| 37 | import org.onosproject.net.flow.DefaultFlowRule; |
| 38 | import org.onosproject.net.flow.DefaultTrafficSelector; |
| 39 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 40 | import org.onosproject.net.flow.FlowRule; |
| 41 | import org.onosproject.net.flow.FlowRuleService; |
| 42 | import org.onosproject.net.flow.TrafficSelector; |
| 43 | import org.onosproject.net.flow.TrafficTreatment; |
| 44 | import org.onosproject.net.host.HostService; |
| 45 | import org.onosproject.net.packet.InboundPacket; |
| 46 | import org.onosproject.net.packet.PacketContext; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 47 | import org.onosproject.net.packet.PacketPriority; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 48 | import org.onosproject.net.packet.PacketProcessor; |
| 49 | import org.onosproject.net.packet.PacketService; |
| 50 | import org.onosproject.net.topology.TopologyService; |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 51 | import org.osgi.service.component.ComponentContext; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 52 | import org.slf4j.Logger; |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 53 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 54 | /** |
| 55 | * Sample reactive forwarding application. |
| 56 | */ |
| 57 | @Component(immediate = true) |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 58 | public class ReactiveForwarding { |
| 59 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 60 | private static final int TIMEOUT = 10; |
alshabib | a0e0498 | 2014-10-03 13:03:19 -0700 | [diff] [blame] | 61 | private static final int PRIORITY = 10; |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 62 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 63 | private final Logger log = getLogger(getClass()); |
| 64 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 66 | protected TopologyService topologyService; |
| 67 | |
| 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected PacketService packetService; |
| 70 | |
alshabib | 8aef1ad | 2014-09-15 17:47:31 -0700 | [diff] [blame] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 72 | protected HostService hostService; |
| 73 | |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 75 | protected FlowRuleService flowRuleService; |
| 76 | |
alshabib | 92c65ad | 2014-10-08 21:56:05 -0700 | [diff] [blame] | 77 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 78 | protected CoreService coreService; |
| 79 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 80 | private ReactivePacketProcessor processor = new ReactivePacketProcessor(); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 81 | |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 82 | private ApplicationId appId; |
| 83 | |
Thomas Vachuska | bd7f4b3 | 2014-12-04 20:54:55 -0800 | [diff] [blame] | 84 | @Property(name = "packetOutOnly", boolValue = false, |
| 85 | label = "Enable packet-out only forwarding; default is false") |
| 86 | private boolean packetOutOnly = false; |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 87 | |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 88 | @Property(name = "ipv6Forwarding", boolValue = false, |
| 89 | label = "Enable IPv6 forwarding; default is false") |
| 90 | private boolean ipv6Forwarding = false; |
| 91 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 92 | @Activate |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 93 | public void activate(ComponentContext context) { |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 94 | appId = coreService.registerApplication("org.onosproject.fwd"); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 95 | |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 96 | packetService.addProcessor(processor, PacketProcessor.ADVISOR_MAX + 2); |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 97 | readComponentConfiguration(context); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 98 | |
| 99 | TrafficSelector.Builder selector = DefaultTrafficSelector.builder(); |
| 100 | selector.matchEthType(Ethernet.TYPE_IPV4); |
| 101 | packetService.requestPackets(selector.build(), PacketPriority.REACTIVE, appId); |
| 102 | |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 103 | log.info("Started with Application ID {}", appId.id()); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | @Deactivate |
| 107 | public void deactivate() { |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 108 | flowRuleService.removeFlowRulesById(appId); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 109 | packetService.removeProcessor(processor); |
| 110 | processor = null; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 111 | log.info("Stopped"); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 112 | } |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 113 | |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 114 | @Modified |
| 115 | public void modified(ComponentContext context) { |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 116 | readComponentConfiguration(context); |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Extracts properties from the component configuration context. |
| 121 | * |
| 122 | * @param context the component context |
| 123 | */ |
| 124 | private void readComponentConfiguration(ComponentContext context) { |
| 125 | Dictionary<?, ?> properties = context.getProperties(); |
| 126 | boolean packetOutOnlyEnabled = isPropertyEnabled(properties, "packetOutOnly"); |
| 127 | if (packetOutOnly != packetOutOnlyEnabled) { |
| 128 | packetOutOnly = packetOutOnlyEnabled; |
| 129 | log.info("Configured. Packet-out only forwarding is {}", |
| 130 | packetOutOnly ? "enabled" : "disabled"); |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 131 | } |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 132 | boolean ipv6ForwardingEnabled = isPropertyEnabled(properties, "ipv6Forwarding"); |
| 133 | if (ipv6Forwarding != ipv6ForwardingEnabled) { |
| 134 | ipv6Forwarding = ipv6ForwardingEnabled; |
| 135 | log.info("Configured. IPv6 forwarding is {}", |
| 136 | ipv6Forwarding ? "enabled" : "disabled"); |
| 137 | } |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Check property name is defined and set to true. |
| 142 | * |
| 143 | * @param properties properties to be looked up |
| 144 | * @param propertyName the name of the property to look up |
| 145 | * @return true when the propertyName is defined and set to true |
| 146 | */ |
| 147 | private static boolean isPropertyEnabled(Dictionary<?, ?> properties, String propertyName) { |
| 148 | boolean enabled = false; |
| 149 | try { |
| 150 | String flag = (String) properties.get(propertyName); |
| 151 | if (flag != null) { |
Ayaka Koshibe | 8851ed9 | 2015-01-22 12:07:24 -0800 | [diff] [blame^] | 152 | enabled = flag.trim().equals("true"); |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 153 | } |
| 154 | } catch (ClassCastException e) { |
| 155 | // No propertyName defined. |
| 156 | enabled = false; |
| 157 | } |
| 158 | return enabled; |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 159 | } |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 160 | |
| 161 | /** |
| 162 | * Packet processor responsible for forwarding packets along their paths. |
| 163 | */ |
| 164 | private class ReactivePacketProcessor implements PacketProcessor { |
| 165 | |
| 166 | @Override |
| 167 | public void process(PacketContext context) { |
tom | dc95b8a | 2014-09-17 08:07:26 -0700 | [diff] [blame] | 168 | // Stop processing if the packet has been handled, since we |
| 169 | // can't do any more to it. |
Thomas Vachuska | bd7f4b3 | 2014-12-04 20:54:55 -0800 | [diff] [blame] | 170 | if (context.isHandled()) { |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 171 | return; |
| 172 | } |
tom | dc95b8a | 2014-09-17 08:07:26 -0700 | [diff] [blame] | 173 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 174 | InboundPacket pkt = context.inPacket(); |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 175 | Ethernet ethPkt = pkt.parsed(); |
alshabib | 6eb438a | 2014-10-01 16:39:37 -0700 | [diff] [blame] | 176 | |
Jonathan Hart | e8600eb | 2015-01-12 10:30:45 -0800 | [diff] [blame] | 177 | if (ethPkt == null) { |
| 178 | return; |
| 179 | } |
| 180 | |
Kunihiro Ishiguro | d37c9ca | 2014-12-31 16:05:40 +0900 | [diff] [blame] | 181 | // Bail if this is deemed to be a control packet. |
| 182 | if (isControlPacket(ethPkt)) { |
| 183 | return; |
| 184 | } |
| 185 | |
| 186 | // Skip IPv6 multicast packet when IPv6 forward is disabled. |
| 187 | if (!ipv6Forwarding && isIpv6Multicast(ethPkt)) { |
Thomas Vachuska | 01a6ec0 | 2014-11-05 09:54:09 -0800 | [diff] [blame] | 188 | return; |
| 189 | } |
| 190 | |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 191 | HostId id = HostId.hostId(ethPkt.getDestinationMAC()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 192 | |
Thomas Vachuska | e1bcb0b | 2014-10-27 17:45:10 -0700 | [diff] [blame] | 193 | // Do not process link-local addresses in any way. |
| 194 | if (id.mac().isLinkLocal()) { |
| 195 | return; |
| 196 | } |
| 197 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 198 | // Do we know who this is for? If not, flood and bail. |
| 199 | Host dst = hostService.getHost(id); |
| 200 | if (dst == null) { |
| 201 | flood(context); |
| 202 | return; |
| 203 | } |
| 204 | |
| 205 | // Are we on an edge switch that our destination is on? If so, |
| 206 | // simply forward out to the destination and bail. |
| 207 | if (pkt.receivedFrom().deviceId().equals(dst.location().deviceId())) { |
alshabib | 6eb438a | 2014-10-01 16:39:37 -0700 | [diff] [blame] | 208 | if (!context.inPacket().receivedFrom().port().equals(dst.location().port())) { |
| 209 | installRule(context, dst.location().port()); |
| 210 | } |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 211 | return; |
| 212 | } |
| 213 | |
| 214 | // Otherwise, get a set of paths that lead from here to the |
| 215 | // destination edge switch. |
| 216 | Set<Path> paths = topologyService.getPaths(topologyService.currentTopology(), |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 217 | pkt.receivedFrom().deviceId(), |
| 218 | dst.location().deviceId()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 219 | if (paths.isEmpty()) { |
| 220 | // If there are no paths, flood and bail. |
| 221 | flood(context); |
| 222 | return; |
| 223 | } |
| 224 | |
| 225 | // Otherwise, pick a path that does not lead back to where we |
| 226 | // came from; if no such path, flood and bail. |
| 227 | Path path = pickForwardPath(paths, pkt.receivedFrom().port()); |
| 228 | if (path == null) { |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 229 | log.warn("Doh... don't know where to go... {} -> {} received on {}", |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 230 | ethPkt.getSourceMAC(), ethPkt.getDestinationMAC(), |
| 231 | pkt.receivedFrom()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 232 | flood(context); |
| 233 | return; |
| 234 | } |
| 235 | |
| 236 | // Otherwise forward and be done with it. |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 237 | installRule(context, path.src().port()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 238 | } |
Thomas Vachuska | 01a6ec0 | 2014-11-05 09:54:09 -0800 | [diff] [blame] | 239 | |
| 240 | } |
| 241 | |
| 242 | // Indicates whether this is a control packet, e.g. LLDP, BDDP |
| 243 | private boolean isControlPacket(Ethernet eth) { |
| 244 | short type = eth.getEtherType(); |
| 245 | return type == Ethernet.TYPE_LLDP || type == Ethernet.TYPE_BSN; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 246 | } |
| 247 | |
Thomas Vachuska | 5dd52f7 | 2014-11-28 19:27:45 -0800 | [diff] [blame] | 248 | // Indicated whether this is an IPv6 multicast packet. |
| 249 | private boolean isIpv6Multicast(Ethernet eth) { |
| 250 | return eth.getEtherType() == Ethernet.TYPE_IPV6 && eth.isMulticast(); |
| 251 | } |
| 252 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 253 | // Selects a path from the given set that does not lead back to the |
| 254 | // specified port. |
| 255 | private Path pickForwardPath(Set<Path> paths, PortNumber notToPort) { |
| 256 | for (Path path : paths) { |
| 257 | if (!path.src().port().equals(notToPort)) { |
| 258 | return path; |
| 259 | } |
| 260 | } |
| 261 | return null; |
| 262 | } |
| 263 | |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 264 | // Floods the specified packet if permissible. |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 265 | private void flood(PacketContext context) { |
tom | dc95b8a | 2014-09-17 08:07:26 -0700 | [diff] [blame] | 266 | if (topologyService.isBroadcastPoint(topologyService.currentTopology(), |
tom | c16656f | 2014-10-15 18:30:31 -0700 | [diff] [blame] | 267 | context.inPacket().receivedFrom())) { |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 268 | packetOut(context, PortNumber.FLOOD); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 269 | } else { |
| 270 | context.block(); |
| 271 | } |
| 272 | } |
| 273 | |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 274 | // Sends a packet out the specified port. |
| 275 | private void packetOut(PacketContext context, PortNumber portNumber) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 276 | context.treatmentBuilder().setOutput(portNumber); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 277 | context.send(); |
| 278 | } |
| 279 | |
| 280 | // Install a rule forwarding the packet to the specified port. |
| 281 | private void installRule(PacketContext context, PortNumber portNumber) { |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 282 | // We don't yet support bufferids in the flowservice so packet out first. |
| 283 | packetOut(context, portNumber); |
Thomas Vachuska | bd7f4b3 | 2014-12-04 20:54:55 -0800 | [diff] [blame] | 284 | if (!packetOutOnly) { |
| 285 | // Install the flow rule to handle this type of message from now on. |
| 286 | Ethernet inPkt = context.inPacket().parsed(); |
| 287 | TrafficSelector.Builder builder = DefaultTrafficSelector.builder(); |
| 288 | builder.matchEthType(inPkt.getEtherType()) |
| 289 | .matchEthSrc(inPkt.getSourceMAC()) |
| 290 | .matchEthDst(inPkt.getDestinationMAC()) |
| 291 | .matchInport(context.inPacket().receivedFrom().port()); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 292 | |
Thomas Vachuska | bd7f4b3 | 2014-12-04 20:54:55 -0800 | [diff] [blame] | 293 | TrafficTreatment.Builder treat = DefaultTrafficTreatment.builder(); |
| 294 | treat.setOutput(portNumber); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 295 | |
Thomas Vachuska | bd7f4b3 | 2014-12-04 20:54:55 -0800 | [diff] [blame] | 296 | FlowRule f = new DefaultFlowRule(context.inPacket().receivedFrom().deviceId(), |
| 297 | builder.build(), treat.build(), PRIORITY, appId, TIMEOUT, false); |
alshabib | 6eb438a | 2014-10-01 16:39:37 -0700 | [diff] [blame] | 298 | |
Thomas Vachuska | bd7f4b3 | 2014-12-04 20:54:55 -0800 | [diff] [blame] | 299 | flowRuleService.applyFlowRules(f); |
| 300 | } |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 301 | } |
| 302 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 303 | } |
| 304 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 305 | |