alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 1 | package org.onlab.onos.fwd; |
| 2 | |
alshabib | e9d3a32 | 2014-09-23 15:18:33 -0700 | [diff] [blame] | 3 | import static org.slf4j.LoggerFactory.getLogger; |
| 4 | |
| 5 | import java.util.Set; |
| 6 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 7 | import org.apache.felix.scr.annotations.Activate; |
| 8 | import org.apache.felix.scr.annotations.Component; |
| 9 | import org.apache.felix.scr.annotations.Deactivate; |
| 10 | import org.apache.felix.scr.annotations.Reference; |
| 11 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 12 | import org.onlab.onos.ApplicationId; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 13 | import org.onlab.onos.net.Host; |
| 14 | import org.onlab.onos.net.HostId; |
| 15 | import org.onlab.onos.net.Path; |
| 16 | import org.onlab.onos.net.PortNumber; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 17 | import org.onlab.onos.net.flow.DefaultFlowRule; |
| 18 | import org.onlab.onos.net.flow.DefaultTrafficSelector; |
| 19 | import org.onlab.onos.net.flow.DefaultTrafficTreatment; |
| 20 | import org.onlab.onos.net.flow.FlowRule; |
| 21 | import org.onlab.onos.net.flow.FlowRuleService; |
| 22 | import org.onlab.onos.net.flow.TrafficSelector; |
| 23 | import org.onlab.onos.net.flow.TrafficTreatment; |
alshabib | 8aef1ad | 2014-09-15 17:47:31 -0700 | [diff] [blame] | 24 | import org.onlab.onos.net.host.HostService; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 25 | import org.onlab.onos.net.packet.InboundPacket; |
| 26 | import org.onlab.onos.net.packet.PacketContext; |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 27 | import org.onlab.onos.net.packet.PacketProcessor; |
| 28 | import org.onlab.onos.net.packet.PacketService; |
| 29 | import org.onlab.onos.net.topology.TopologyService; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 30 | import org.onlab.packet.Ethernet; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 31 | import org.slf4j.Logger; |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 32 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 33 | /** |
| 34 | * Sample reactive forwarding application. |
| 35 | */ |
| 36 | @Component(immediate = true) |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 37 | public class ReactiveForwarding { |
| 38 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 39 | private final Logger log = getLogger(getClass()); |
| 40 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 41 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 42 | protected TopologyService topologyService; |
| 43 | |
| 44 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 45 | protected PacketService packetService; |
| 46 | |
alshabib | 8aef1ad | 2014-09-15 17:47:31 -0700 | [diff] [blame] | 47 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 48 | protected HostService hostService; |
| 49 | |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 50 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 51 | protected FlowRuleService flowRuleService; |
| 52 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 53 | private ReactivePacketProcessor processor = new ReactivePacketProcessor(); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 54 | |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 55 | private ApplicationId appId; |
| 56 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 57 | @Activate |
| 58 | public void activate() { |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 59 | appId = ApplicationId.getAppId(); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 60 | packetService.addProcessor(processor, PacketProcessor.ADVISOR_MAX + 1); |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 61 | log.info("Started with Application ID {}", appId.id()); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | @Deactivate |
| 65 | public void deactivate() { |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 66 | flowRuleService.removeFlowRulesById(appId); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 67 | packetService.removeProcessor(processor); |
| 68 | processor = null; |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 69 | log.info("Stopped"); |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 70 | } |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 71 | |
| 72 | |
| 73 | /** |
| 74 | * Packet processor responsible for forwarding packets along their paths. |
| 75 | */ |
| 76 | private class ReactivePacketProcessor implements PacketProcessor { |
| 77 | |
| 78 | @Override |
| 79 | public void process(PacketContext context) { |
tom | dc95b8a | 2014-09-17 08:07:26 -0700 | [diff] [blame] | 80 | // Stop processing if the packet has been handled, since we |
| 81 | // can't do any more to it. |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 82 | if (context.isHandled()) { |
| 83 | return; |
| 84 | } |
tom | dc95b8a | 2014-09-17 08:07:26 -0700 | [diff] [blame] | 85 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 86 | InboundPacket pkt = context.inPacket(); |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 87 | Ethernet ethPkt = pkt.parsed(); |
| 88 | HostId id = HostId.hostId(ethPkt.getDestinationMAC()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 89 | |
| 90 | // Do we know who this is for? If not, flood and bail. |
| 91 | Host dst = hostService.getHost(id); |
| 92 | if (dst == null) { |
| 93 | flood(context); |
| 94 | return; |
| 95 | } |
| 96 | |
| 97 | // Are we on an edge switch that our destination is on? If so, |
| 98 | // simply forward out to the destination and bail. |
| 99 | if (pkt.receivedFrom().deviceId().equals(dst.location().deviceId())) { |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 100 | installRule(context, dst.location().port()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 101 | return; |
| 102 | } |
| 103 | |
| 104 | // Otherwise, get a set of paths that lead from here to the |
| 105 | // destination edge switch. |
| 106 | Set<Path> paths = topologyService.getPaths(topologyService.currentTopology(), |
alshabib | e9d3a32 | 2014-09-23 15:18:33 -0700 | [diff] [blame] | 107 | pkt.receivedFrom().deviceId(), |
| 108 | dst.location().deviceId()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 109 | if (paths.isEmpty()) { |
| 110 | // If there are no paths, flood and bail. |
| 111 | flood(context); |
| 112 | return; |
| 113 | } |
| 114 | |
| 115 | // Otherwise, pick a path that does not lead back to where we |
| 116 | // came from; if no such path, flood and bail. |
| 117 | Path path = pickForwardPath(paths, pkt.receivedFrom().port()); |
| 118 | if (path == null) { |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 119 | log.warn("Doh... don't know where to go... {} -> {} received on {}", |
alshabib | e9d3a32 | 2014-09-23 15:18:33 -0700 | [diff] [blame] | 120 | ethPkt.getSourceMAC(), ethPkt.getDestinationMAC(), |
| 121 | pkt.receivedFrom()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 122 | flood(context); |
| 123 | return; |
| 124 | } |
| 125 | |
| 126 | // Otherwise forward and be done with it. |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 127 | installRule(context, path.src().port()); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 128 | } |
| 129 | } |
| 130 | |
| 131 | // Selects a path from the given set that does not lead back to the |
| 132 | // specified port. |
| 133 | private Path pickForwardPath(Set<Path> paths, PortNumber notToPort) { |
| 134 | for (Path path : paths) { |
| 135 | if (!path.src().port().equals(notToPort)) { |
| 136 | return path; |
| 137 | } |
| 138 | } |
| 139 | return null; |
| 140 | } |
| 141 | |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 142 | // Floods the specified packet if permissible. |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 143 | private void flood(PacketContext context) { |
tom | dc95b8a | 2014-09-17 08:07:26 -0700 | [diff] [blame] | 144 | if (topologyService.isBroadcastPoint(topologyService.currentTopology(), |
alshabib | e9d3a32 | 2014-09-23 15:18:33 -0700 | [diff] [blame] | 145 | context.inPacket().receivedFrom())) { |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 146 | packetOut(context, PortNumber.FLOOD); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 147 | } else { |
| 148 | context.block(); |
| 149 | } |
| 150 | } |
| 151 | |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 152 | // Sends a packet out the specified port. |
| 153 | private void packetOut(PacketContext context, PortNumber portNumber) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame^] | 154 | context.treatmentBuilder().setOutput(portNumber); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 155 | context.send(); |
| 156 | } |
| 157 | |
| 158 | // Install a rule forwarding the packet to the specified port. |
| 159 | private void installRule(PacketContext context, PortNumber portNumber) { |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 160 | // We don't yet support bufferids in the flowservice so packet out first. |
| 161 | packetOut(context, portNumber); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 162 | |
tom | 642b226 | 2014-09-17 13:52:55 -0700 | [diff] [blame] | 163 | // Install the flow rule to handle this type of message from now on. |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 164 | Ethernet inPkt = context.inPacket().parsed(); |
| 165 | TrafficSelector.Builder builder = new DefaultTrafficSelector.Builder(); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame^] | 166 | builder.matchEthType(inPkt.getEtherType()) |
| 167 | .matchEthSrc(inPkt.getSourceMAC()) |
| 168 | .matchEthDst(inPkt.getDestinationMAC()) |
| 169 | .matchInport(context.inPacket().receivedFrom().port()); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 170 | |
| 171 | TrafficTreatment.Builder treat = new DefaultTrafficTreatment.Builder(); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame^] | 172 | treat.setOutput(portNumber); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 173 | |
| 174 | FlowRule f = new DefaultFlowRule(context.inPacket().receivedFrom().deviceId(), |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame] | 175 | builder.build(), treat.build(), 0, appId); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 176 | |
| 177 | flowRuleService.applyFlowRules(f); |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 178 | } |
| 179 | |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 180 | } |
| 181 | |
tom | c370ebd | 2014-09-16 01:25:21 -0700 | [diff] [blame] | 182 | |