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