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