blob: ce2826c343bc10e33a87d08c34cf1101510f2cf8 [file] [log] [blame]
Thomas Vachuska781d18b2014-10-27 10:31:25 -07001/*
Ray Milkey34c95902015-04-15 09:47:53 -07002 * Copyright 2014-2015 Open Networking Laboratory
Thomas Vachuska781d18b2014-10-27 10:31:25 -07003 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07004 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
Thomas Vachuska781d18b2014-10-27 10:31:25 -07007 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07008 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
Thomas Vachuska781d18b2014-10-27 10:31:25 -070015 */
Brian O'Connorabafb502014-12-02 22:26:20 -080016package org.onosproject.provider.lldp.impl;
alshabib7911a052014-10-16 17:49:37 -070017
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -080018import static com.google.common.base.Strings.isNullOrEmpty;
19import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor;
20import static java.util.concurrent.TimeUnit.SECONDS;
21import static org.onlab.packet.Ethernet.TYPE_BSN;
22import static org.onlab.packet.Ethernet.TYPE_LLDP;
23import static org.onlab.util.Tools.get;
24import static org.onlab.util.Tools.groupedThreads;
25import static org.onosproject.net.Link.Type.DIRECT;
26import static org.onosproject.net.config.basics.SubjectFactories.APP_SUBJECT_FACTORY;
27import static org.onosproject.net.config.basics.SubjectFactories.CONNECT_POINT_SUBJECT_FACTORY;
28import static org.onosproject.net.config.basics.SubjectFactories.DEVICE_SUBJECT_FACTORY;
29import static org.slf4j.LoggerFactory.getLogger;
30
31import java.util.Dictionary;
32import java.util.EnumSet;
33import java.util.Map;
34import java.util.Optional;
35import java.util.Properties;
36import java.util.Set;
37import java.util.concurrent.ConcurrentHashMap;
38import java.util.concurrent.ScheduledExecutorService;
39
alshabib7911a052014-10-16 17:49:37 -070040import org.apache.felix.scr.annotations.Activate;
41import org.apache.felix.scr.annotations.Component;
42import org.apache.felix.scr.annotations.Deactivate;
Yuta HIGUCHI41289382014-12-19 17:47:12 -080043import org.apache.felix.scr.annotations.Modified;
44import org.apache.felix.scr.annotations.Property;
alshabib7911a052014-10-16 17:49:37 -070045import org.apache.felix.scr.annotations.Reference;
46import org.apache.felix.scr.annotations.ReferenceCardinality;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080047import org.onlab.packet.Ethernet;
Thomas Vachuskaaad8b1d2015-12-11 10:36:53 -080048import org.onlab.util.Tools;
Thomas Vachuska6519e6f2015-03-11 02:29:31 -070049import org.onosproject.cfg.ComponentConfigService;
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -070050import org.onosproject.cluster.ClusterService;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080051import org.onosproject.core.ApplicationId;
52import org.onosproject.core.CoreService;
Brian O'Connorabafb502014-12-02 22:26:20 -080053import org.onosproject.mastership.MastershipEvent;
54import org.onosproject.mastership.MastershipListener;
55import org.onosproject.mastership.MastershipService;
56import org.onosproject.net.ConnectPoint;
57import org.onosproject.net.Device;
58import org.onosproject.net.DeviceId;
Thomas Vachuskae4ebac92015-09-10 11:39:05 -070059import org.onosproject.net.LinkKey;
Brian O'Connorabafb502014-12-02 22:26:20 -080060import org.onosproject.net.Port;
Naoki Shiota399a0b32015-11-15 20:36:13 -060061import org.onosproject.net.config.ConfigFactory;
62import org.onosproject.net.config.NetworkConfigEvent;
63import org.onosproject.net.config.NetworkConfigListener;
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -070064import org.onosproject.net.config.NetworkConfigRegistry;
Brian O'Connorabafb502014-12-02 22:26:20 -080065import org.onosproject.net.device.DeviceEvent;
66import org.onosproject.net.device.DeviceListener;
67import org.onosproject.net.device.DeviceService;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080068import org.onosproject.net.flow.DefaultTrafficSelector;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080069import org.onosproject.net.flow.TrafficSelector;
Thomas Vachuskae4ebac92015-09-10 11:39:05 -070070import org.onosproject.net.link.DefaultLinkDescription;
Brian O'Connorabafb502014-12-02 22:26:20 -080071import org.onosproject.net.link.LinkProvider;
72import org.onosproject.net.link.LinkProviderRegistry;
73import org.onosproject.net.link.LinkProviderService;
Thomas Vachuskae4ebac92015-09-10 11:39:05 -070074import org.onosproject.net.link.LinkService;
Brian O'Connorabafb502014-12-02 22:26:20 -080075import org.onosproject.net.packet.PacketContext;
Jonathan Hart3cfce8e2015-01-14 16:43:27 -080076import org.onosproject.net.packet.PacketPriority;
Brian O'Connorabafb502014-12-02 22:26:20 -080077import org.onosproject.net.packet.PacketProcessor;
78import org.onosproject.net.packet.PacketService;
79import org.onosproject.net.provider.AbstractProvider;
80import org.onosproject.net.provider.ProviderId;
Thomas Vachuskaaad8b1d2015-12-11 10:36:53 -080081import org.onosproject.store.service.ConsistentMapException;
Yuta HIGUCHI41289382014-12-19 17:47:12 -080082import org.osgi.service.component.ComponentContext;
alshabib7911a052014-10-16 17:49:37 -070083import org.slf4j.Logger;
84
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -080085import com.google.common.collect.ImmutableMap;
86import com.google.common.collect.ImmutableSet;
87import com.google.common.collect.Maps;
Yuta HIGUCHI41289382014-12-19 17:47:12 -080088
alshabib7911a052014-10-16 17:49:37 -070089/**
Thomas Vachuska05453c92015-09-09 14:40:49 -070090 * Provider which uses LLDP and BDDP packets to detect network infrastructure links.
alshabib7911a052014-10-16 17:49:37 -070091 */
92@Component(immediate = true)
Jonathan Hartb35540a2015-11-17 09:30:56 -080093public class LldpLinkProvider extends AbstractProvider implements LinkProvider {
alshabib7911a052014-10-16 17:49:37 -070094
Thomas Vachuskafc52fec2015-05-18 19:13:56 -070095 private static final String PROVIDER_NAME = "org.onosproject.provider.lldp";
96
Thomas Vachuska05453c92015-09-09 14:40:49 -070097 private static final String FORMAT =
98 "Settings: enabled={}, useBDDP={}, probeRate={}, " +
Naoki Shiota399a0b32015-11-15 20:36:13 -060099 "staleLinkAge={}";
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800100
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700101 // When a Device/Port has this annotation, do not send out LLDP/BDDP
102 public static final String NO_LLDP = "no-lldp";
103
Thomas Vachuskaaad8b1d2015-12-11 10:36:53 -0800104 private static final int MAX_RETRIES = 5;
105 private static final int RETRY_DELAY = 1_000; // millis
106
alshabib7911a052014-10-16 17:49:37 -0700107 private final Logger log = getLogger(getClass());
108
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -0800109 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
110 protected CoreService coreService;
111
112 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
alshabib7911a052014-10-16 17:49:37 -0700113 protected LinkProviderRegistry providerRegistry;
114
115 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
116 protected DeviceService deviceService;
117
118 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700119 protected LinkService linkService;
120
121 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Marc De Leenheer8b3e80b2015-03-06 14:27:03 -0800122 protected PacketService packetService;
alshabib7911a052014-10-16 17:49:37 -0700123
alshabib875d6262014-10-17 16:19:40 -0700124 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
125 protected MastershipService masterService;
126
Thomas Vachuska6519e6f2015-03-11 02:29:31 -0700127 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
128 protected ComponentConfigService cfgService;
129
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700130 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
131 protected ClusterService clusterService;
132
133 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
134 protected NetworkConfigRegistry cfgRegistry;
135
alshabib7911a052014-10-16 17:49:37 -0700136 private LinkProviderService providerService;
137
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800138 private ScheduledExecutorService executor;
139
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700140 // TODO: Add sanity checking for the configurable params based on the delays
141 private static final long DEVICE_SYNC_DELAY = 5;
142 private static final long LINK_PRUNER_DELAY = 3;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700143
144 private static final String PROP_ENABLED = "enabled";
145 @Property(name = PROP_ENABLED, boolValue = true,
146 label = "If false, link discovery is disabled")
147 private boolean enabled = false;
148
149 private static final String PROP_USE_BDDP = "useBDDP";
Thomas Vachuska6519e6f2015-03-11 02:29:31 -0700150 @Property(name = PROP_USE_BDDP, boolValue = true,
151 label = "Use BDDP for link discovery")
Jonathan Hartb35540a2015-11-17 09:30:56 -0800152 private boolean useBddp = true;
alshabib7911a052014-10-16 17:49:37 -0700153
Thomas Vachuska05453c92015-09-09 14:40:49 -0700154 private static final String PROP_PROBE_RATE = "probeRate";
155 private static final int DEFAULT_PROBE_RATE = 3_000;
156 @Property(name = PROP_PROBE_RATE, intValue = DEFAULT_PROBE_RATE,
157 label = "LLDP and BDDP probe rate specified in millis")
158 private int probeRate = DEFAULT_PROBE_RATE;
Saurav Dasc313c402015-02-27 10:09:47 -0800159
Thomas Vachuska05453c92015-09-09 14:40:49 -0700160 private static final String PROP_STALE_LINK_AGE = "staleLinkAge";
161 private static final int DEFAULT_STALE_LINK_AGE = 10_000;
162 @Property(name = PROP_STALE_LINK_AGE, intValue = DEFAULT_STALE_LINK_AGE,
163 label = "Number of millis beyond which links will be considered stale")
164 private int staleLinkAge = DEFAULT_STALE_LINK_AGE;
alshabib7911a052014-10-16 17:49:37 -0700165
Thomas Vachuska05453c92015-09-09 14:40:49 -0700166 private final DiscoveryContext context = new InternalDiscoveryContext();
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800167 private final InternalRoleListener roleListener = new InternalRoleListener();
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700168 private final InternalDeviceListener deviceListener = new InternalDeviceListener();
169 private final InternalPacketProcessor packetProcessor = new InternalPacketProcessor();
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800170
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700171 // Device link discovery helpers.
alshabib7911a052014-10-16 17:49:37 -0700172 protected final Map<DeviceId, LinkDiscovery> discoverers = new ConcurrentHashMap<>();
173
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700174 // Most recent time a tracked link was seen; links are tracked if their
175 // destination connection point is mastered by this controller instance.
176 private final Map<LinkKey, Long> linkTimes = Maps.newConcurrentMap();
177
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -0800178 private ApplicationId appId;
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800179
Naoki Shiota399a0b32015-11-15 20:36:13 -0600180 static final SuppressionRules DEFAULT_RULES
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800181 = new SuppressionRules(EnumSet.of(Device.Type.ROADM),
Naoki Shiota399a0b32015-11-15 20:36:13 -0600182 ImmutableMap.of(NO_LLDP, SuppressionRules.ANY_VALUE));
183
184 private SuppressionRules rules = LldpLinkProvider.DEFAULT_RULES;
185
186 public static final String CONFIG_KEY = "suppression";
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800187 public static final String FEATURE_NAME = "linkDiscovery";
Naoki Shiota399a0b32015-11-15 20:36:13 -0600188
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800189 private final Set<ConfigFactory<?, ?>> factories = ImmutableSet.of(
Naoki Shiota399a0b32015-11-15 20:36:13 -0600190 new ConfigFactory<ApplicationId, SuppressionConfig>(APP_SUBJECT_FACTORY,
191 SuppressionConfig.class,
192 CONFIG_KEY) {
193 @Override
194 public SuppressionConfig createConfig() {
195 return new SuppressionConfig();
196 }
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800197 },
198 new ConfigFactory<DeviceId, LinkDiscoveryFromDevice>(DEVICE_SUBJECT_FACTORY,
199 LinkDiscoveryFromDevice.class, FEATURE_NAME) {
200 @Override
201 public LinkDiscoveryFromDevice createConfig() {
202 return new LinkDiscoveryFromDevice();
203 }
204 },
205 new ConfigFactory<ConnectPoint, LinkDiscoveryFromPort>(CONNECT_POINT_SUBJECT_FACTORY,
206 LinkDiscoveryFromPort.class, FEATURE_NAME) {
207 @Override
208 public LinkDiscoveryFromPort createConfig() {
209 return new LinkDiscoveryFromPort();
210 }
Naoki Shiota399a0b32015-11-15 20:36:13 -0600211 }
212 );
213
214 private final InternalConfigListener cfgListener = new InternalConfigListener();
215
216
alshabib7911a052014-10-16 17:49:37 -0700217 /**
218 * Creates an OpenFlow link provider.
219 */
Jonathan Hartb35540a2015-11-17 09:30:56 -0800220 public LldpLinkProvider() {
Thomas Vachuskafc52fec2015-05-18 19:13:56 -0700221 super(new ProviderId("lldp", PROVIDER_NAME));
alshabib7911a052014-10-16 17:49:37 -0700222 }
223
224 @Activate
Saurav Dasc313c402015-02-27 10:09:47 -0800225 public void activate(ComponentContext context) {
Thomas Vachuska6519e6f2015-03-11 02:29:31 -0700226 cfgService.registerProperties(getClass());
Thomas Vachuskafc52fec2015-05-18 19:13:56 -0700227 appId = coreService.registerApplication(PROVIDER_NAME);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600228
229 cfgRegistry.addListener(cfgListener);
230 factories.forEach(cfgRegistry::registerConfigFactory);
231
232 SuppressionConfig cfg = cfgRegistry.getConfig(appId, SuppressionConfig.class);
233 if (cfg == null) {
234 // If no configuration is found, register default.
Thomas Vachuskaaad8b1d2015-12-11 10:36:53 -0800235 cfg = Tools.retryable(this::setDefaultSuppressionConfig,
236 ConsistentMapException.class,
237 MAX_RETRIES, RETRY_DELAY).get();
Naoki Shiota399a0b32015-11-15 20:36:13 -0600238 }
239 cfgListener.reconfigureSuppressionRules(cfg);
240
Saurav Dasc313c402015-02-27 10:09:47 -0800241 modified(context);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700242 log.info("Started");
243 }
244
Thomas Vachuskaaad8b1d2015-12-11 10:36:53 -0800245 private SuppressionConfig setDefaultSuppressionConfig() {
246 SuppressionConfig cfg = cfgRegistry.addConfig(appId, SuppressionConfig.class);
247 cfg.deviceTypes(DEFAULT_RULES.getSuppressedDeviceType())
248 .annotation(DEFAULT_RULES.getSuppressedAnnotation())
249 .apply();
250 return cfg;
251 }
252
Thomas Vachuska05453c92015-09-09 14:40:49 -0700253 @Deactivate
254 public void deactivate() {
Naoki Shiota399a0b32015-11-15 20:36:13 -0600255 cfgRegistry.removeListener(cfgListener);
256 factories.forEach(cfgRegistry::unregisterConfigFactory);
257
Thomas Vachuska05453c92015-09-09 14:40:49 -0700258 cfgService.unregisterProperties(getClass(), false);
259 disable();
260 log.info("Stopped");
261 }
262
263 @Modified
264 public void modified(ComponentContext context) {
265 Dictionary<?, ?> properties = context != null ? context.getProperties() : new Properties();
266
267 boolean newEnabled, newUseBddp;
268 int newProbeRate, newStaleLinkAge;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700269 try {
270 String s = get(properties, PROP_ENABLED);
271 newEnabled = isNullOrEmpty(s) || Boolean.parseBoolean(s.trim());
272
273 s = get(properties, PROP_USE_BDDP);
274 newUseBddp = isNullOrEmpty(s) || Boolean.parseBoolean(s.trim());
275
276 s = get(properties, PROP_PROBE_RATE);
277 newProbeRate = isNullOrEmpty(s) ? probeRate : Integer.parseInt(s.trim());
278
279 s = get(properties, PROP_STALE_LINK_AGE);
280 newStaleLinkAge = isNullOrEmpty(s) ? staleLinkAge : Integer.parseInt(s.trim());
281
Thomas Vachuska05453c92015-09-09 14:40:49 -0700282 } catch (NumberFormatException e) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700283 log.warn("Component configuration had invalid values", e);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700284 newEnabled = enabled;
Jonathan Hartb35540a2015-11-17 09:30:56 -0800285 newUseBddp = useBddp;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700286 newProbeRate = probeRate;
287 newStaleLinkAge = staleLinkAge;
Saurav Dasc313c402015-02-27 10:09:47 -0800288 }
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800289
Thomas Vachuska05453c92015-09-09 14:40:49 -0700290 boolean wasEnabled = enabled;
291
292 enabled = newEnabled;
Jonathan Hartb35540a2015-11-17 09:30:56 -0800293 useBddp = newUseBddp;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700294 probeRate = newProbeRate;
295 staleLinkAge = newStaleLinkAge;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700296
297 if (!wasEnabled && enabled) {
298 enable();
299 } else if (wasEnabled && !enabled) {
300 disable();
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700301 } else {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700302 if (enabled) {
303 // update all discovery helper state
304 loadDevices();
305 }
Thomas Vachuska05453c92015-09-09 14:40:49 -0700306 }
307
Naoki Shiota399a0b32015-11-15 20:36:13 -0600308 log.info(FORMAT, enabled, useBddp, probeRate, staleLinkAge);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700309 }
310
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700311 /**
312 * Enables link discovery processing.
313 */
Thomas Vachuska05453c92015-09-09 14:40:49 -0700314 private void enable() {
alshabib7911a052014-10-16 17:49:37 -0700315 providerService = providerRegistry.register(this);
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800316 masterService.addListener(roleListener);
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700317 deviceService.addListener(deviceListener);
318 packetService.addProcessor(packetProcessor, PacketProcessor.advisor(0));
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800319
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700320 loadDevices();
Thomas Vachuska05453c92015-09-09 14:40:49 -0700321
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700322 executor = newSingleThreadScheduledExecutor(groupedThreads("onos/link", "discovery-%d"));
323 executor.scheduleAtFixedRate(new SyncDeviceInfoTask(),
324 DEVICE_SYNC_DELAY, DEVICE_SYNC_DELAY, SECONDS);
325 executor.scheduleAtFixedRate(new LinkPrunerTask(),
326 LINK_PRUNER_DELAY, LINK_PRUNER_DELAY, SECONDS);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700327
Thomas Vachuska05453c92015-09-09 14:40:49 -0700328 requestIntercepts();
329 }
330
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700331 /**
332 * Disables link discovery processing.
333 */
Thomas Vachuska05453c92015-09-09 14:40:49 -0700334 private void disable() {
335 withdrawIntercepts();
336
337 providerRegistry.unregister(this);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700338 masterService.removeListener(roleListener);
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700339 deviceService.removeListener(deviceListener);
340 packetService.removeProcessor(packetProcessor);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700341
Naoki Shiota399a0b32015-11-15 20:36:13 -0600342
Thomas Vachuska05453c92015-09-09 14:40:49 -0700343 if (executor != null) {
344 executor.shutdownNow();
345 }
346 discoverers.values().forEach(LinkDiscovery::stop);
347 discoverers.clear();
348
349 providerService = null;
350 }
351
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700352 /**
353 * Loads available devices and registers their ports to be probed.
354 */
355 private void loadDevices() {
Naoki Shiota399a0b32015-11-15 20:36:13 -0600356 if (!enabled) {
357 return;
358 }
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700359 deviceService.getAvailableDevices()
360 .forEach(d -> updateDevice(d)
361 .ifPresent(ld -> updatePorts(ld, d.id())));
362 }
363
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800364 private boolean isBlacklisted(DeviceId did) {
365 LinkDiscoveryFromDevice cfg = cfgRegistry.getConfig(did, LinkDiscoveryFromDevice.class);
366 if (cfg == null) {
367 return false;
368 }
369 return !cfg.enabled();
370 }
371
372 private boolean isBlacklisted(ConnectPoint cp) {
373 // if parent device is blacklisted, so is the port
374 if (isBlacklisted(cp.deviceId())) {
375 return true;
376 }
377 LinkDiscoveryFromPort cfg = cfgRegistry.getConfig(cp, LinkDiscoveryFromPort.class);
378 if (cfg == null) {
379 return false;
380 }
381 return !cfg.enabled();
382 }
383
384 private boolean isBlacklisted(Port port) {
385 return isBlacklisted(new ConnectPoint(port.element().id(), port.number()));
386 }
387
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700388 /**
389 * Updates discovery helper for specified device.
390 *
391 * Adds and starts a discovery helper for specified device if enabled,
392 * calls {@link #removeDevice(DeviceId)} otherwise.
393 *
394 * @param device device to add
395 * @return discovery helper if discovery is enabled for the device
396 */
397 private Optional<LinkDiscovery> updateDevice(Device device) {
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800398 if (device == null) {
399 return Optional.empty();
400 }
401 if (rules.isSuppressed(device) || isBlacklisted(device.id())) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700402 log.trace("LinkDiscovery from {} disabled by configuration", device.id());
403 removeDevice(device.id());
404 return Optional.empty();
405 }
406 LinkDiscovery ld = discoverers.computeIfAbsent(device.id(),
407 did -> new LinkDiscovery(device, context));
408 if (ld.isStopped()) {
409 ld.start();
410 }
411 return Optional.of(ld);
412 }
413
414 /**
415 * Removes after stopping discovery helper for specified device.
416 * @param deviceId device to remove
417 */
418 private void removeDevice(final DeviceId deviceId) {
419 discoverers.computeIfPresent(deviceId, (did, ld) -> {
420 ld.stop();
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700421 return null;
422 });
423
424 }
425
426 /**
427 * Updates ports of the specified device to the specified discovery helper.
428 */
429 private void updatePorts(LinkDiscovery discoverer, DeviceId deviceId) {
430 deviceService.getPorts(deviceId).forEach(p -> updatePort(discoverer, p));
431 }
432
433 /**
434 * Updates discovery helper state of the specified port.
435 *
436 * Adds a port to the discovery helper if up and discovery is enabled,
437 * or calls {@link #removePort(Port)} otherwise.
438 */
439 private void updatePort(LinkDiscovery discoverer, Port port) {
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800440 if (port == null) {
441 return;
442 }
HIGUCHI Yutab853b3f2015-11-17 18:43:20 -0800443 if (port.number().isLogical()) {
444 // silently ignore logical ports
445 return;
446 }
Naoki Shiota399a0b32015-11-15 20:36:13 -0600447
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800448 if (rules.isSuppressed(port) || isBlacklisted(port)) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700449 log.trace("LinkDiscovery from {} disabled by configuration", port);
450 removePort(port);
451 return;
452 }
453
454 // check if enabled and turn off discovery?
455 if (!port.isEnabled()) {
456 removePort(port);
457 return;
458 }
459
HIGUCHI Yutab853b3f2015-11-17 18:43:20 -0800460 discoverer.addPort(port);
alshabib7911a052014-10-16 17:49:37 -0700461 }
462
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700463 /**
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700464 * Removes a port from the specified discovery helper.
465 * @param port the port
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700466 */
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700467 private void removePort(Port port) {
468 if (port.element() instanceof Device) {
469 Device d = (Device) port.element();
470 LinkDiscovery ld = discoverers.get(d.id());
471 if (ld != null) {
472 ld.removePort(port.number());
Jonathan Hart45066bc2015-07-28 11:18:34 -0700473 }
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700474 } else {
475 log.warn("Attempted to remove non-Device port", port);
Jonathan Hart45066bc2015-07-28 11:18:34 -0700476 }
477 }
478
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700479 /**
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700480 * Requests packet intercepts.
Charles M.C. Chane148de82015-05-06 12:38:21 +0800481 */
Thomas Vachuska27bee092015-06-23 19:03:10 -0700482 private void requestIntercepts() {
483 TrafficSelector.Builder selector = DefaultTrafficSelector.builder();
Thomas Vachuska347cc872015-09-23 10:25:29 -0700484 selector.matchEthType(TYPE_LLDP);
Thomas Vachuska27bee092015-06-23 19:03:10 -0700485 packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId);
Jonathan Hart3cfce8e2015-01-14 16:43:27 -0800486
Thomas Vachuska347cc872015-09-23 10:25:29 -0700487 selector.matchEthType(TYPE_BSN);
Jonathan Hartb35540a2015-11-17 09:30:56 -0800488 if (useBddp) {
Thomas Vachuska27bee092015-06-23 19:03:10 -0700489 packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId);
490 } else {
491 packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId);
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -0800492 }
493 }
494
Thomas Vachuska27bee092015-06-23 19:03:10 -0700495 /**
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700496 * Withdraws packet intercepts.
Thomas Vachuska27bee092015-06-23 19:03:10 -0700497 */
498 private void withdrawIntercepts() {
499 TrafficSelector.Builder selector = DefaultTrafficSelector.builder();
Thomas Vachuska347cc872015-09-23 10:25:29 -0700500 selector.matchEthType(TYPE_LLDP);
Thomas Vachuska27bee092015-06-23 19:03:10 -0700501 packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId);
Thomas Vachuska347cc872015-09-23 10:25:29 -0700502 selector.matchEthType(TYPE_BSN);
Thomas Vachuska27bee092015-06-23 19:03:10 -0700503 packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId);
504 }
505
Naoki Shiota399a0b32015-11-15 20:36:13 -0600506 protected SuppressionRules rules() {
507 return rules;
508 }
509
510 protected void updateRules(SuppressionRules newRules) {
511 if (!rules.equals(newRules)) {
512 rules = newRules;
513 loadDevices();
514 }
515 }
516
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700517 /**
518 * Processes device mastership role changes.
519 */
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800520 private class InternalRoleListener implements MastershipListener {
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800521 @Override
522 public void event(MastershipEvent event) {
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800523 if (MastershipEvent.Type.BACKUPS_CHANGED.equals(event.type())) {
524 // only need new master events
525 return;
526 }
527
528 DeviceId deviceId = event.subject();
529 Device device = deviceService.getDevice(deviceId);
530 if (device == null) {
Thomas Vachuska3358af22015-05-19 18:40:34 -0700531 log.debug("Device {} doesn't exist, or isn't there yet", deviceId);
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800532 return;
533 }
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700534 if (clusterService.getLocalNode().id().equals(event.roleInfo().master())) {
535 updateDevice(device).ifPresent(ld -> updatePorts(ld, device.id()));
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800536 }
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800537 }
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800538 }
alshabib7911a052014-10-16 17:49:37 -0700539
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700540 /**
541 * Processes device events.
542 */
543 private class InternalDeviceListener implements DeviceListener {
alshabib7911a052014-10-16 17:49:37 -0700544 @Override
545 public void event(DeviceEvent event) {
alshabib7911a052014-10-16 17:49:37 -0700546 Device device = event.subject();
alshabibacd91832014-10-17 14:38:41 -0700547 Port port = event.port();
alshabibdfc7afb2014-10-21 20:13:27 -0700548 if (device == null) {
549 log.error("Device is null.");
550 return;
551 }
Yuta HIGUCHIeb24e9d2014-10-26 19:34:20 -0700552 log.trace("{} {} {}", event.type(), event.subject(), event);
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700553 final DeviceId deviceId = device.id();
alshabib7911a052014-10-16 17:49:37 -0700554 switch (event.type()) {
555 case DEVICE_ADDED:
Yuta HIGUCHIeb24e9d2014-10-26 19:34:20 -0700556 case DEVICE_UPDATED:
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700557 updateDevice(device).ifPresent(ld -> updatePorts(ld, deviceId));
alshabib7911a052014-10-16 17:49:37 -0700558 break;
559 case PORT_ADDED:
560 case PORT_UPDATED:
Yuta HIGUCHIf6725882014-10-29 15:25:51 -0700561 if (port.isEnabled()) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700562 updateDevice(device).ifPresent(ld -> updatePort(ld, port));
alshabib7911a052014-10-16 17:49:37 -0700563 } else {
Yuta HIGUCHIf6725882014-10-29 15:25:51 -0700564 log.debug("Port down {}", port);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700565 removePort(port);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600566 providerService.linksVanished(new ConnectPoint(port.element().id(),
567 port.number()));
alshabib7911a052014-10-16 17:49:37 -0700568 }
569 break;
570 case PORT_REMOVED:
Yuta HIGUCHIeb24e9d2014-10-26 19:34:20 -0700571 log.debug("Port removed {}", port);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700572 removePort(port);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600573 providerService.linksVanished(new ConnectPoint(port.element().id(),
574 port.number()));
alshabib7911a052014-10-16 17:49:37 -0700575 break;
576 case DEVICE_REMOVED:
577 case DEVICE_SUSPENDED:
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700578 log.debug("Device removed {}", deviceId);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700579 removeDevice(deviceId);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600580 providerService.linksVanished(deviceId);
alshabib7911a052014-10-16 17:49:37 -0700581 break;
582 case DEVICE_AVAILABILITY_CHANGED:
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700583 if (deviceService.isAvailable(deviceId)) {
584 log.debug("Device up {}", deviceId);
alshabibe3af2652015-12-01 23:05:34 -0800585 updateDevice(device).ifPresent(ld -> updatePorts(ld, deviceId));
alshabib7911a052014-10-16 17:49:37 -0700586 } else {
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700587 log.debug("Device down {}", deviceId);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700588 removeDevice(deviceId);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600589 providerService.linksVanished(deviceId);
alshabib7911a052014-10-16 17:49:37 -0700590 }
591 break;
Jonathan Hart9de692c2015-04-23 11:45:47 -0700592 case PORT_STATS_UPDATED:
593 break;
alshabib7911a052014-10-16 17:49:37 -0700594 default:
595 log.debug("Unknown event {}", event);
596 }
597 }
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700598 }
alshabib7911a052014-10-16 17:49:37 -0700599
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700600 /**
601 * Processes incoming packets.
602 */
603 private class InternalPacketProcessor implements PacketProcessor {
alshabib7911a052014-10-16 17:49:37 -0700604 @Override
605 public void process(PacketContext context) {
Thomas Vachuska347cc872015-09-23 10:25:29 -0700606 if (context == null || context.isHandled()) {
alshabib4a179dc2014-10-17 17:17:01 -0700607 return;
608 }
Thomas Vachuska347cc872015-09-23 10:25:29 -0700609
610 Ethernet eth = context.inPacket().parsed();
611 if (eth == null || (eth.getEtherType() != TYPE_LLDP && eth.getEtherType() != TYPE_BSN)) {
612 return;
613 }
614
Thomas Vachuska96f3ea72015-09-08 13:50:12 -0700615 LinkDiscovery ld = discoverers.get(context.inPacket().receivedFrom().deviceId());
alshabib7911a052014-10-16 17:49:37 -0700616 if (ld == null) {
617 return;
618 }
619
Jonathan Hartb35540a2015-11-17 09:30:56 -0800620 if (ld.handleLldp(context)) {
alshabib7911a052014-10-16 17:49:37 -0700621 context.block();
622 }
623 }
624 }
625
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700626 /**
627 * Auxiliary task to keep device ports up to date.
628 */
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800629 private final class SyncDeviceInfoTask implements Runnable {
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800630 @Override
631 public void run() {
632 if (Thread.currentThread().isInterrupted()) {
633 log.info("Interrupted, quitting");
634 return;
635 }
636 // check what deviceService sees, to see if we are missing anything
637 try {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700638 loadDevices();
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800639 } catch (Exception e) {
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700640 // Catch all exceptions to avoid task being suppressed
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800641 log.error("Exception thrown during synchronization process", e);
642 }
643 }
644 }
645
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700646 /**
647 * Auxiliary task for pruning stale links.
648 */
649 private class LinkPrunerTask implements Runnable {
650 @Override
651 public void run() {
652 if (Thread.currentThread().isInterrupted()) {
653 log.info("Interrupted, quitting");
654 return;
655 }
656
657 try {
658 // TODO: There is still a slight possibility of mastership
659 // change occurring right with link going stale. This will
660 // result in the stale link not being pruned.
661 Maps.filterEntries(linkTimes, e -> {
662 if (!masterService.isLocalMaster(e.getKey().dst().deviceId())) {
663 return true;
664 }
665 if (isStale(e.getValue())) {
666 providerService.linkVanished(new DefaultLinkDescription(e.getKey().src(),
667 e.getKey().dst(),
668 DIRECT));
669 return true;
670 }
671 return false;
672 }).clear();
673
674 } catch (Exception e) {
675 // Catch all exceptions to avoid task being suppressed
676 log.error("Exception thrown during link pruning process", e);
677 }
678 }
679
680 private boolean isStale(long lastSeen) {
681 return lastSeen < System.currentTimeMillis() - staleLinkAge;
682 }
683 }
684
685 /**
686 * Provides processing context for the device link discovery helpers.
687 */
Thomas Vachuska05453c92015-09-09 14:40:49 -0700688 private class InternalDiscoveryContext implements DiscoveryContext {
689 @Override
690 public MastershipService mastershipService() {
691 return masterService;
692 }
693
694 @Override
695 public LinkProviderService providerService() {
696 return providerService;
697 }
698
699 @Override
700 public PacketService packetService() {
701 return packetService;
702 }
703
704 @Override
705 public long probeRate() {
706 return probeRate;
707 }
708
709 @Override
Jonathan Hartb35540a2015-11-17 09:30:56 -0800710 public boolean useBddp() {
711 return useBddp;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700712 }
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700713
714 @Override
715 public void touchLink(LinkKey key) {
716 linkTimes.put(key, System.currentTimeMillis());
717 }
Thomas Vachuska05453c92015-09-09 14:40:49 -0700718 }
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700719
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800720 static final EnumSet<NetworkConfigEvent.Type> CONFIG_CHANGED
721 = EnumSet.of(NetworkConfigEvent.Type.CONFIG_ADDED,
722 NetworkConfigEvent.Type.CONFIG_UPDATED,
723 NetworkConfigEvent.Type.CONFIG_REMOVED);
724
Naoki Shiota399a0b32015-11-15 20:36:13 -0600725 private class InternalConfigListener implements NetworkConfigListener {
726
727 private synchronized void reconfigureSuppressionRules(SuppressionConfig cfg) {
728 if (cfg == null) {
729 log.error("Suppression Config is null.");
730 return;
731 }
732
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800733 SuppressionRules newRules = new SuppressionRules(cfg.deviceTypes(),
Naoki Shiota399a0b32015-11-15 20:36:13 -0600734 cfg.annotation());
735
736 updateRules(newRules);
737 }
738
739 @Override
740 public void event(NetworkConfigEvent event) {
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800741 if (event.configClass() == LinkDiscoveryFromDevice.class &&
742 CONFIG_CHANGED.contains(event.type())) {
743
744 if (event.subject() instanceof DeviceId) {
745 final DeviceId did = (DeviceId) event.subject();
746 Device device = deviceService.getDevice(did);
747 updateDevice(device).ifPresent(ld -> updatePorts(ld, did));
748 }
749
750 } else if (event.configClass() == LinkDiscoveryFromPort.class &&
751 CONFIG_CHANGED.contains(event.type())) {
752
753 if (event.subject() instanceof ConnectPoint) {
754 ConnectPoint cp = (ConnectPoint) event.subject();
755 if (cp.elementId() instanceof DeviceId) {
756 final DeviceId did = (DeviceId) cp.elementId();
757 Device device = deviceService.getDevice(did);
758 Port port = deviceService.getPort(did, cp.port());
759 updateDevice(device).ifPresent(ld -> updatePort(ld, port));
760 }
761 }
762
763 } else if (event.configClass().equals(SuppressionConfig.class) &&
Naoki Shiota399a0b32015-11-15 20:36:13 -0600764 (event.type() == NetworkConfigEvent.Type.CONFIG_ADDED ||
765 event.type() == NetworkConfigEvent.Type.CONFIG_UPDATED)) {
766 SuppressionConfig cfg = cfgRegistry.getConfig(appId, SuppressionConfig.class);
767 reconfigureSuppressionRules(cfg);
768 log.trace("Network config reconfigured");
769 }
770 }
771 }
alshabib7911a052014-10-16 17:49:37 -0700772}