alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 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 | */ |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 16 | package org.onosproject.igmp; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 17 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Modified; |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 22 | import org.apache.felix.scr.annotations.Property; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 25 | import org.onlab.packet.EthType; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 26 | import org.onlab.packet.Ethernet; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 27 | import org.onlab.packet.IGMP; |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 28 | import org.onlab.packet.IGMPMembership; |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 29 | import org.onlab.packet.IGMPQuery; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 30 | import org.onlab.packet.IPv4; |
| 31 | import org.onlab.packet.Ip4Address; |
| 32 | import org.onlab.packet.IpAddress; |
| 33 | import org.onlab.packet.IpPrefix; |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 34 | import org.onlab.util.SafeRecurringTask; |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 35 | import org.onlab.util.Tools; |
| 36 | import org.onosproject.cfg.ComponentConfigService; |
alshabib | 4809e54 | 2016-04-28 15:52:22 -0700 | [diff] [blame] | 37 | import org.onosproject.cordconfig.access.AccessDeviceConfig; |
| 38 | import org.onosproject.cordconfig.access.AccessDeviceData; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 39 | import org.onosproject.core.ApplicationId; |
| 40 | import org.onosproject.core.CoreService; |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 41 | import org.onosproject.net.ConnectPoint; |
| 42 | import org.onosproject.net.DeviceId; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 43 | import org.onosproject.net.Port; |
| 44 | import org.onosproject.net.PortNumber; |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 45 | import org.onosproject.net.config.ConfigFactory; |
| 46 | import org.onosproject.net.config.NetworkConfigEvent; |
| 47 | import org.onosproject.net.config.NetworkConfigListener; |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 48 | import org.onosproject.net.config.NetworkConfigRegistry; |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 49 | import org.onosproject.net.config.basics.SubjectFactories; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 50 | import org.onosproject.net.device.DeviceEvent; |
| 51 | import org.onosproject.net.device.DeviceListener; |
| 52 | import org.onosproject.net.device.DeviceService; |
| 53 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 54 | import org.onosproject.net.flow.TrafficTreatment; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 55 | import org.onosproject.net.flow.criteria.Criteria; |
| 56 | import org.onosproject.net.flowobjective.DefaultFilteringObjective; |
| 57 | import org.onosproject.net.flowobjective.FilteringObjective; |
| 58 | import org.onosproject.net.flowobjective.FlowObjectiveService; |
| 59 | import org.onosproject.net.flowobjective.Objective; |
| 60 | import org.onosproject.net.flowobjective.ObjectiveContext; |
| 61 | import org.onosproject.net.flowobjective.ObjectiveError; |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 62 | import org.onosproject.net.mcast.McastRoute; |
| 63 | import org.onosproject.net.mcast.MulticastRouteService; |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 64 | import org.onosproject.net.packet.DefaultOutboundPacket; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 65 | import org.onosproject.net.packet.InboundPacket; |
| 66 | import org.onosproject.net.packet.PacketContext; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 67 | import org.onosproject.net.packet.PacketProcessor; |
| 68 | import org.onosproject.net.packet.PacketService; |
alshabib | 4809e54 | 2016-04-28 15:52:22 -0700 | [diff] [blame] | 69 | |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 70 | import org.osgi.service.component.ComponentContext; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 71 | import org.slf4j.Logger; |
| 72 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 73 | import java.nio.ByteBuffer; |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 74 | import java.util.Collection; |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 75 | import java.util.Dictionary; |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 76 | import java.util.List; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 77 | import java.util.Map; |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 78 | import java.util.Properties; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 79 | import java.util.concurrent.ConcurrentHashMap; |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 80 | import java.util.concurrent.Executors; |
| 81 | import java.util.concurrent.ScheduledExecutorService; |
| 82 | import java.util.concurrent.ScheduledFuture; |
| 83 | import java.util.concurrent.TimeUnit; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 84 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 85 | import static org.onlab.util.Tools.groupedThreads; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 86 | import static org.slf4j.LoggerFactory.getLogger; |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 87 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 88 | /** |
| 89 | * Internet Group Management Protocol. |
| 90 | */ |
| 91 | @Component(immediate = true) |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 92 | public class IgmpSnoop { |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 93 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 94 | private final Logger log = getLogger(getClass()); |
| 95 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 96 | private static final String DEST_MAC = "01:00:5E:00:00:01"; |
| 97 | private static final String DEST_IP = "224.0.0.1"; |
| 98 | |
| 99 | private static final int DEFAULT_QUERY_PERIOD_SECS = 60; |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 100 | private static final byte DEFAULT_IGMP_RESP_CODE = 100; |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 101 | |
| 102 | @Property(name = "multicastAddress", |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 103 | label = "Define the multicast base range to listen to") |
Charles Chan | aedabfd | 2016-02-26 09:31:48 -0800 | [diff] [blame] | 104 | private String multicastAddress = IpPrefix.IPV4_MULTICAST_PREFIX.toString(); |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 105 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 106 | @Property(name = "queryPeriod", intValue = DEFAULT_QUERY_PERIOD_SECS, |
| 107 | label = "Delay in seconds between successive query runs") |
| 108 | private int queryPeriod = DEFAULT_QUERY_PERIOD_SECS; |
| 109 | |
| 110 | @Property(name = "maxRespCode", byteValue = DEFAULT_IGMP_RESP_CODE, |
| 111 | label = "Maximum time allowed before sending a responding report") |
| 112 | private byte maxRespCode = DEFAULT_IGMP_RESP_CODE; |
| 113 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 114 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 115 | protected FlowObjectiveService flowObjectiveService; |
| 116 | |
| 117 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 118 | protected PacketService packetService; |
| 119 | |
| 120 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 121 | protected CoreService coreService; |
| 122 | |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 123 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 124 | protected NetworkConfigRegistry networkConfig; |
| 125 | |
| 126 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 127 | protected ComponentConfigService componentConfigService; |
| 128 | |
| 129 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 130 | protected MulticastRouteService multicastService; |
| 131 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 132 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 133 | protected DeviceService deviceService; |
| 134 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 135 | |
| 136 | private ScheduledFuture<?> queryTask; |
| 137 | private final ScheduledExecutorService queryService = |
| 138 | Executors.newSingleThreadScheduledExecutor(groupedThreads("onos/igmp-query", |
| 139 | "membership-query")); |
| 140 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 141 | private Map<DeviceId, AccessDeviceData> oltData = new ConcurrentHashMap<>(); |
| 142 | |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 143 | private Map<IpAddress, IpAddress> ssmTranslateTable = new ConcurrentHashMap<>(); |
| 144 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 145 | private DeviceListener deviceListener = new InternalDeviceListener(); |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 146 | private IgmpPacketProcessor processor = new IgmpPacketProcessor(); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 147 | private static ApplicationId appId; |
| 148 | |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 149 | private InternalNetworkConfigListener configListener = |
| 150 | new InternalNetworkConfigListener(); |
| 151 | |
| 152 | private static final Class<AccessDeviceConfig> CONFIG_CLASS = |
| 153 | AccessDeviceConfig.class; |
| 154 | |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 155 | private static final Class<IgmpSsmTranslateConfig> SSM_TRANSLATE_CONFIG_CLASS = |
| 156 | IgmpSsmTranslateConfig.class; |
| 157 | |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 158 | private ConfigFactory<DeviceId, AccessDeviceConfig> configFactory = |
| 159 | new ConfigFactory<DeviceId, AccessDeviceConfig>( |
| 160 | SubjectFactories.DEVICE_SUBJECT_FACTORY, CONFIG_CLASS, "accessDevice") { |
| 161 | @Override |
| 162 | public AccessDeviceConfig createConfig() { |
| 163 | return new AccessDeviceConfig(); |
| 164 | } |
| 165 | }; |
| 166 | |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 167 | private ConfigFactory<ApplicationId, IgmpSsmTranslateConfig> ssmTranslateConfigFactory = |
| 168 | new ConfigFactory<ApplicationId, IgmpSsmTranslateConfig>( |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 169 | SubjectFactories.APP_SUBJECT_FACTORY, SSM_TRANSLATE_CONFIG_CLASS, "ssmTranslate", true) { |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 170 | @Override |
| 171 | public IgmpSsmTranslateConfig createConfig() { |
| 172 | return new IgmpSsmTranslateConfig(); |
| 173 | } |
| 174 | }; |
| 175 | |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 176 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 177 | private ByteBuffer queryPacket; |
| 178 | |
| 179 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 180 | @Activate |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 181 | public void activate(ComponentContext context) { |
Jonathan Hart | 9ad777f | 2016-02-19 12:44:36 -0800 | [diff] [blame] | 182 | componentConfigService.registerProperties(getClass()); |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 183 | modified(context); |
| 184 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 185 | appId = coreService.registerApplication("org.onosproject.igmp"); |
| 186 | |
| 187 | packetService.addProcessor(processor, PacketProcessor.director(1)); |
| 188 | |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 189 | networkConfig.registerConfigFactory(configFactory); |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 190 | networkConfig.registerConfigFactory(ssmTranslateConfigFactory); |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 191 | networkConfig.addListener(configListener); |
| 192 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 193 | networkConfig.getSubjects(DeviceId.class, AccessDeviceConfig.class).forEach( |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 194 | subject -> { |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 195 | AccessDeviceConfig config = networkConfig.getConfig(subject, |
| 196 | AccessDeviceConfig.class); |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 197 | if (config != null) { |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 198 | AccessDeviceData data = config.getOlt(); |
| 199 | oltData.put(data.deviceId(), data); |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 200 | |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 201 | } |
| 202 | } |
| 203 | ); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 204 | |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 205 | IgmpSsmTranslateConfig ssmTranslateConfig = |
| 206 | networkConfig.getConfig(appId, IgmpSsmTranslateConfig.class); |
| 207 | |
| 208 | if (ssmTranslateConfig != null) { |
| 209 | Collection<McastRoute> translations = ssmTranslateConfig.getSsmTranslations(); |
| 210 | for (McastRoute route : translations) { |
| 211 | ssmTranslateTable.put(route.group(), route.source()); |
| 212 | } |
| 213 | } |
| 214 | |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 215 | oltData.keySet().stream() |
| 216 | .flatMap(did -> deviceService.getPorts(did).stream()) |
| 217 | .filter(p -> !oltData.get(p.element().id()).uplink().equals(p.number())) |
| 218 | .filter(p -> p.isEnabled()) |
| 219 | .forEach(p -> processFilterObjective((DeviceId) p.element().id(), p, false)); |
| 220 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 221 | deviceService.addListener(deviceListener); |
| 222 | |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 223 | restartQueryTask(); |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 224 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 225 | log.info("Started"); |
| 226 | } |
| 227 | |
| 228 | @Deactivate |
| 229 | public void deactivate() { |
| 230 | packetService.removeProcessor(processor); |
| 231 | processor = null; |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 232 | deviceService.removeListener(deviceListener); |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 233 | networkConfig.removeListener(configListener); |
| 234 | networkConfig.unregisterConfigFactory(configFactory); |
Jonathan Hart | 5e8689c | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 235 | networkConfig.unregisterConfigFactory(ssmTranslateConfigFactory); |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 236 | queryTask.cancel(true); |
| 237 | queryService.shutdownNow(); |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 238 | componentConfigService.unregisterProperties(getClass(), false); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 239 | log.info("Stopped"); |
| 240 | } |
| 241 | |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 242 | @Modified |
| 243 | protected void modified(ComponentContext context) { |
| 244 | Dictionary<?, ?> properties = context != null ? context.getProperties() : new Properties(); |
| 245 | |
Charles Chan | aedabfd | 2016-02-26 09:31:48 -0800 | [diff] [blame] | 246 | // TODO read multicastAddress from config |
Jonathan Hart | 81d7310 | 2016-02-19 10:32:05 -0800 | [diff] [blame] | 247 | String strQueryPeriod = Tools.get(properties, "queryPeriod"); |
| 248 | String strResponseCode = Tools.get(properties, "maxRespCode"); |
| 249 | try { |
| 250 | byte newMaxRespCode = Byte.parseByte(strResponseCode); |
| 251 | if (maxRespCode != newMaxRespCode) { |
| 252 | maxRespCode = newMaxRespCode; |
| 253 | queryPacket = buildQueryPacket(); |
| 254 | } |
| 255 | |
| 256 | int newQueryPeriod = Integer.parseInt(strQueryPeriod); |
| 257 | if (newQueryPeriod != queryPeriod) { |
| 258 | queryPeriod = newQueryPeriod; |
| 259 | restartQueryTask(); |
| 260 | } |
| 261 | |
| 262 | } catch (NumberFormatException e) { |
| 263 | log.warn("Error parsing config input", e); |
| 264 | } |
| 265 | |
| 266 | log.info("queryPeriod set to {}", queryPeriod); |
| 267 | log.info("maxRespCode set to {}", maxRespCode); |
| 268 | } |
| 269 | |
| 270 | private void restartQueryTask() { |
| 271 | if (queryTask != null) { |
| 272 | queryTask.cancel(true); |
| 273 | } |
| 274 | queryPacket = buildQueryPacket(); |
| 275 | queryTask = queryService.scheduleWithFixedDelay( |
| 276 | SafeRecurringTask.wrap(this::querySubscribers), |
| 277 | 0, |
| 278 | queryPeriod, |
| 279 | TimeUnit.SECONDS); |
| 280 | } |
| 281 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 282 | private void processFilterObjective(DeviceId devId, Port port, boolean remove) { |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 283 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 284 | //TODO migrate to packet requests when packet service uses filtering objectives |
| 285 | DefaultFilteringObjective.Builder builder = DefaultFilteringObjective.builder(); |
| 286 | |
| 287 | builder = remove ? builder.deny() : builder.permit(); |
| 288 | |
| 289 | FilteringObjective igmp = builder |
| 290 | .withKey(Criteria.matchInPort(port.number())) |
| 291 | .addCondition(Criteria.matchEthType(EthType.EtherType.IPV4.ethType())) |
| 292 | .addCondition(Criteria.matchIPProtocol(IPv4.PROTOCOL_IGMP)) |
| 293 | .withMeta(DefaultTrafficTreatment.builder() |
| 294 | .setOutput(PortNumber.CONTROLLER).build()) |
| 295 | .fromApp(appId) |
alshabib | 1aa5814 | 2016-02-17 15:37:56 -0800 | [diff] [blame] | 296 | .withPriority(10000) |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 297 | .add(new ObjectiveContext() { |
| 298 | @Override |
| 299 | public void onSuccess(Objective objective) { |
| 300 | log.info("Igmp filter for {} on {} installed.", |
| 301 | devId, port); |
| 302 | } |
| 303 | |
| 304 | @Override |
| 305 | public void onError(Objective objective, ObjectiveError error) { |
| 306 | log.info("Igmp filter for {} on {} failed because {}.", |
| 307 | devId, port, error); |
| 308 | } |
| 309 | }); |
| 310 | |
| 311 | flowObjectiveService.filter(devId, igmp); |
| 312 | } |
| 313 | |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 314 | private void processMembership(IGMP pkt, ConnectPoint location) { |
| 315 | pkt.getGroups().forEach(group -> { |
| 316 | |
| 317 | if (!(group instanceof IGMPMembership)) { |
| 318 | log.warn("Wrong group type in IGMP membership"); |
| 319 | return; |
| 320 | } |
| 321 | |
| 322 | IGMPMembership membership = (IGMPMembership) group; |
| 323 | |
Jonathan Hart | 81b0914 | 2016-04-27 10:09:33 -0700 | [diff] [blame] | 324 | IpAddress groupAddress = membership.getGaddr(); |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 325 | |
| 326 | if (membership.getRecordType() == IGMPMembership.MODE_IS_INCLUDE || |
| 327 | membership.getRecordType() == IGMPMembership.CHANGE_TO_INCLUDE_MODE) { |
| 328 | |
Jonathan Hart | 81b0914 | 2016-04-27 10:09:33 -0700 | [diff] [blame] | 329 | if (membership.getSources().isEmpty()) { |
| 330 | McastRoute route = ssmTranslateRoute(groupAddress); |
| 331 | if (route != null) { |
| 332 | removeRoute(route, location); |
| 333 | } |
| 334 | } else { |
| 335 | membership.getSources().stream() |
| 336 | .map(source -> new McastRoute(source, groupAddress, McastRoute.Type.IGMP)) |
| 337 | .forEach(route -> addRoute(route, location)); |
| 338 | } |
Jonathan Hart | dd7e3d5 | 2016-02-18 15:56:22 -0800 | [diff] [blame] | 339 | } else if (membership.getRecordType() == IGMPMembership.MODE_IS_EXCLUDE || |
| 340 | membership.getRecordType() == IGMPMembership.CHANGE_TO_EXCLUDE_MODE) { |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 341 | |
Jonathan Hart | 81b0914 | 2016-04-27 10:09:33 -0700 | [diff] [blame] | 342 | if (membership.getSources().isEmpty()) { |
| 343 | McastRoute route = ssmTranslateRoute(groupAddress); |
| 344 | if (route != null) { |
| 345 | addRoute(route, location); |
| 346 | } |
| 347 | } else { |
| 348 | membership.getSources().stream() |
| 349 | .map(source -> new McastRoute(source, groupAddress, McastRoute.Type.IGMP)) |
| 350 | .forEach(route -> removeRoute(route, location)); |
| 351 | } |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 352 | } |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 353 | }); |
| 354 | } |
| 355 | |
Jonathan Hart | 81b0914 | 2016-04-27 10:09:33 -0700 | [diff] [blame] | 356 | private McastRoute ssmTranslateRoute(IpAddress group) { |
| 357 | IpAddress source = ssmTranslateTable.get(group); |
| 358 | if (source == null) { |
| 359 | log.warn("No SSM translate source found for group {}", group); |
| 360 | return null; |
| 361 | } |
| 362 | return new McastRoute(source, group, McastRoute.Type.IGMP); |
| 363 | } |
| 364 | |
| 365 | private void addRoute(McastRoute route, ConnectPoint location) { |
| 366 | multicastService.add(route); |
| 367 | multicastService.addSink(route, location); |
| 368 | } |
| 369 | |
| 370 | private void removeRoute(McastRoute route, ConnectPoint location) { |
| 371 | multicastService.removeSink(route, location); |
| 372 | // TODO remove route if all sinks are gone |
| 373 | } |
| 374 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 375 | private ByteBuffer buildQueryPacket() { |
| 376 | IGMP igmp = new IGMP(); |
| 377 | igmp.setIgmpType(IGMP.TYPE_IGMPV3_MEMBERSHIP_QUERY); |
| 378 | igmp.setMaxRespCode(maxRespCode); |
| 379 | |
| 380 | IGMPQuery query = new IGMPQuery(IpAddress.valueOf("0.0.0.0"), 0); |
| 381 | igmp.addGroup(query); |
| 382 | |
| 383 | IPv4 ip = new IPv4(); |
| 384 | ip.setDestinationAddress(DEST_IP); |
| 385 | ip.setProtocol(IPv4.PROTOCOL_IGMP); |
| 386 | ip.setSourceAddress("192.168.1.1"); |
| 387 | ip.setTtl((byte) 1); |
| 388 | ip.setPayload(igmp); |
| 389 | |
| 390 | Ethernet eth = new Ethernet(); |
| 391 | eth.setDestinationMACAddress(DEST_MAC); |
| 392 | eth.setSourceMACAddress("DE:AD:BE:EF:BA:11"); |
| 393 | eth.setEtherType(Ethernet.TYPE_IPV4); |
| 394 | |
| 395 | eth.setPayload(ip); |
| 396 | |
alshabib | 10d68ae | 2016-02-22 16:05:24 -0500 | [diff] [blame] | 397 | eth.setPad(true); |
| 398 | |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 399 | return ByteBuffer.wrap(eth.serialize()); |
| 400 | } |
| 401 | |
| 402 | private void querySubscribers() { |
| 403 | oltData.keySet().stream() |
| 404 | .flatMap(did -> deviceService.getPorts(did).stream()) |
| 405 | .filter(p -> !oltData.get(p.element().id()).uplink().equals(p.number())) |
| 406 | .filter(p -> p.isEnabled()) |
| 407 | .forEach(p -> { |
| 408 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 409 | .setOutput(p.number()).build(); |
| 410 | packetService.emit(new DefaultOutboundPacket((DeviceId) p.element().id(), |
| 411 | treatment, queryPacket)); |
| 412 | }); |
| 413 | } |
| 414 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 415 | /** |
| 416 | * Packet processor responsible for handling IGMP packets. |
| 417 | */ |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 418 | private class IgmpPacketProcessor implements PacketProcessor { |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 419 | |
| 420 | @Override |
| 421 | public void process(PacketContext context) { |
| 422 | // Stop processing if the packet has been handled, since we |
| 423 | // can't do any more to it. |
| 424 | if (context.isHandled()) { |
| 425 | return; |
| 426 | } |
| 427 | |
| 428 | InboundPacket pkt = context.inPacket(); |
| 429 | Ethernet ethPkt = pkt.parsed(); |
| 430 | if (ethPkt == null) { |
| 431 | return; |
| 432 | } |
| 433 | |
Jonathan Hart | 7f4bc52 | 2016-02-20 11:32:43 -0800 | [diff] [blame] | 434 | |
| 435 | // IPv6 MLD packets are handled by ICMP6. We'll only deal with IPv4. |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 436 | if (ethPkt.getEtherType() != Ethernet.TYPE_IPV4) { |
| 437 | return; |
| 438 | } |
| 439 | |
| 440 | IPv4 ip = (IPv4) ethPkt.getPayload(); |
| 441 | IpAddress gaddr = IpAddress.valueOf(ip.getDestinationAddress()); |
| 442 | IpAddress saddr = Ip4Address.valueOf(ip.getSourceAddress()); |
Jonathan Hart | 7f4bc52 | 2016-02-20 11:32:43 -0800 | [diff] [blame] | 443 | log.trace("Packet ({}, {}) -> ingress port: {}", saddr, gaddr, |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 444 | context.inPacket().receivedFrom()); |
| 445 | |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 446 | |
Jonathan Hart | 7f4bc52 | 2016-02-20 11:32:43 -0800 | [diff] [blame] | 447 | if (ip.getProtocol() != IPv4.PROTOCOL_IGMP || |
Charles Chan | aedabfd | 2016-02-26 09:31:48 -0800 | [diff] [blame] | 448 | !IpPrefix.IPV4_MULTICAST_PREFIX.contains(gaddr)) { |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 449 | return; |
| 450 | } |
| 451 | |
Charles Chan | aedabfd | 2016-02-26 09:31:48 -0800 | [diff] [blame] | 452 | if (IpPrefix.IPV4_MULTICAST_PREFIX.contains(saddr)) { |
Rusty Eddy | 158d5d8 | 2015-10-12 16:59:04 -0700 | [diff] [blame] | 453 | log.debug("IGMP Picked up a packet with a multicast source address."); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 454 | return; |
| 455 | } |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 456 | |
| 457 | IGMP igmp = (IGMP) ip.getPayload(); |
| 458 | switch (igmp.getIgmpType()) { |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 459 | case IGMP.TYPE_IGMPV3_MEMBERSHIP_REPORT: |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 460 | processMembership(igmp, pkt.receivedFrom()); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 461 | break; |
| 462 | |
| 463 | case IGMP.TYPE_IGMPV3_MEMBERSHIP_QUERY: |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 464 | log.debug("Received a membership query {} from {}", |
| 465 | igmp, pkt.receivedFrom()); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 466 | break; |
| 467 | |
| 468 | case IGMP.TYPE_IGMPV1_MEMBERSHIP_REPORT: |
| 469 | case IGMP.TYPE_IGMPV2_MEMBERSHIP_REPORT: |
| 470 | case IGMP.TYPE_IGMPV2_LEAVE_GROUP: |
Jonathan Hart | 6ccfc5a | 2016-02-12 19:26:02 -0800 | [diff] [blame] | 471 | log.debug("IGMP version 1 & 2 message types are not currently supported. Message type: {}", |
alshabib | 42d32eb | 2016-02-14 19:53:42 -0800 | [diff] [blame] | 472 | igmp.getIgmpType()); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 473 | break; |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 474 | default: |
Jonathan Hart | 7f4bc52 | 2016-02-20 11:32:43 -0800 | [diff] [blame] | 475 | log.warn("Unknown IGMP message type: {}", igmp.getIgmpType()); |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 476 | break; |
| 477 | } |
| 478 | } |
| 479 | } |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 480 | |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 481 | |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 482 | private class InternalDeviceListener implements DeviceListener { |
| 483 | @Override |
| 484 | public void event(DeviceEvent event) { |
alshabib | 1aa5814 | 2016-02-17 15:37:56 -0800 | [diff] [blame] | 485 | DeviceId devId = event.subject().id(); |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 486 | switch (event.type()) { |
| 487 | |
| 488 | case DEVICE_ADDED: |
| 489 | case DEVICE_UPDATED: |
| 490 | case DEVICE_REMOVED: |
| 491 | case DEVICE_SUSPENDED: |
| 492 | case DEVICE_AVAILABILITY_CHANGED: |
| 493 | case PORT_STATS_UPDATED: |
| 494 | break; |
| 495 | case PORT_ADDED: |
alshabib | 1aa5814 | 2016-02-17 15:37:56 -0800 | [diff] [blame] | 496 | if (!oltData.get(devId).uplink().equals(event.port().number()) && |
| 497 | event.port().isEnabled()) { |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 498 | processFilterObjective(event.subject().id(), event.port(), false); |
| 499 | } |
| 500 | break; |
| 501 | case PORT_UPDATED: |
alshabib | 1aa5814 | 2016-02-17 15:37:56 -0800 | [diff] [blame] | 502 | if (oltData.get(devId).uplink().equals(event.port().number())) { |
| 503 | break; |
| 504 | } |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 505 | if (event.port().isEnabled()) { |
| 506 | processFilterObjective(event.subject().id(), event.port(), false); |
| 507 | } else { |
| 508 | processFilterObjective(event.subject().id(), event.port(), true); |
| 509 | } |
| 510 | break; |
| 511 | case PORT_REMOVED: |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 512 | processFilterObjective(event.subject().id(), event.port(), true); |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 513 | break; |
| 514 | default: |
| 515 | log.warn("Unknown device event {}", event.type()); |
| 516 | break; |
| 517 | } |
alshabib | 03adb49 | 2016-02-01 17:25:00 -0800 | [diff] [blame] | 518 | } |
| 519 | |
| 520 | @Override |
| 521 | public boolean isRelevant(DeviceEvent event) { |
| 522 | return oltData.containsKey(event.subject().id()); |
| 523 | } |
alshabib | 79e5287 | 2015-12-07 16:01:01 -0800 | [diff] [blame] | 524 | } |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 525 | |
| 526 | private class InternalNetworkConfigListener implements NetworkConfigListener { |
| 527 | @Override |
| 528 | public void event(NetworkConfigEvent event) { |
| 529 | switch (event.type()) { |
| 530 | |
| 531 | case CONFIG_ADDED: |
| 532 | case CONFIG_UPDATED: |
| 533 | if (event.configClass().equals(CONFIG_CLASS)) { |
| 534 | AccessDeviceConfig config = |
| 535 | networkConfig.getConfig((DeviceId) event.subject(), CONFIG_CLASS); |
| 536 | if (config != null) { |
| 537 | oltData.put(config.getOlt().deviceId(), config.getOlt()); |
| 538 | provisionDefaultFlows((DeviceId) event.subject()); |
| 539 | } |
| 540 | } |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 541 | if (event.configClass().equals(SSM_TRANSLATE_CONFIG_CLASS)) { |
| 542 | IgmpSsmTranslateConfig config = |
| 543 | networkConfig.getConfig((ApplicationId) event.subject(), |
| 544 | SSM_TRANSLATE_CONFIG_CLASS); |
| 545 | |
| 546 | if (config != null) { |
| 547 | ssmTranslateTable.clear(); |
| 548 | config.getSsmTranslations().forEach( |
| 549 | route -> ssmTranslateTable.put(route.group(), route.source())); |
| 550 | } |
| 551 | } |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 552 | break; |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 553 | case CONFIG_REGISTERED: |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 554 | case CONFIG_UNREGISTERED: |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 555 | break; |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 556 | case CONFIG_REMOVED: |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 557 | if (event.configClass().equals(SSM_TRANSLATE_CONFIG_CLASS)) { |
| 558 | ssmTranslateTable.clear(); |
alshabib | f544c01 | 2016-02-21 14:49:51 -0800 | [diff] [blame] | 559 | } else if (event.configClass().equals(CONFIG_CLASS)) { |
| 560 | oltData.remove(event.subject()); |
Jonathan Hart | 3a8896b | 2016-02-16 13:06:26 -0800 | [diff] [blame] | 561 | } |
alshabib | f544c01 | 2016-02-21 14:49:51 -0800 | [diff] [blame] | 562 | |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 563 | default: |
| 564 | break; |
| 565 | } |
| 566 | } |
| 567 | } |
| 568 | |
| 569 | private void provisionDefaultFlows(DeviceId deviceId) { |
| 570 | List<Port> ports = deviceService.getPorts(deviceId); |
| 571 | |
| 572 | ports.stream() |
| 573 | .filter(p -> !oltData.get(p.element().id()).uplink().equals(p.number())) |
| 574 | .filter(p -> p.isEnabled()) |
| 575 | .forEach(p -> processFilterObjective((DeviceId) p.element().id(), p, false)); |
alshabib | fe69e9a | 2016-02-11 17:31:36 -0800 | [diff] [blame] | 576 | } |
alshabib | eff0054 | 2015-09-23 13:22:33 -0700 | [diff] [blame] | 577 | } |