blob: 668d59c0f79e3f8c98e4fc37ae974f571ba2f9d0 [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 Vachuska6519e6f2015-03-11 02:29:31 -070048import org.onosproject.cfg.ComponentConfigService;
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -070049import org.onosproject.cluster.ClusterService;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080050import org.onosproject.core.ApplicationId;
51import org.onosproject.core.CoreService;
Brian O'Connorabafb502014-12-02 22:26:20 -080052import org.onosproject.mastership.MastershipEvent;
53import org.onosproject.mastership.MastershipListener;
54import org.onosproject.mastership.MastershipService;
55import org.onosproject.net.ConnectPoint;
56import org.onosproject.net.Device;
57import org.onosproject.net.DeviceId;
Thomas Vachuskae4ebac92015-09-10 11:39:05 -070058import org.onosproject.net.LinkKey;
Brian O'Connorabafb502014-12-02 22:26:20 -080059import org.onosproject.net.Port;
Naoki Shiota399a0b32015-11-15 20:36:13 -060060import org.onosproject.net.config.ConfigFactory;
61import org.onosproject.net.config.NetworkConfigEvent;
62import org.onosproject.net.config.NetworkConfigListener;
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -070063import org.onosproject.net.config.NetworkConfigRegistry;
Brian O'Connorabafb502014-12-02 22:26:20 -080064import org.onosproject.net.device.DeviceEvent;
65import org.onosproject.net.device.DeviceListener;
66import org.onosproject.net.device.DeviceService;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080067import org.onosproject.net.flow.DefaultTrafficSelector;
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -080068import org.onosproject.net.flow.TrafficSelector;
Thomas Vachuskae4ebac92015-09-10 11:39:05 -070069import org.onosproject.net.link.DefaultLinkDescription;
Brian O'Connorabafb502014-12-02 22:26:20 -080070import org.onosproject.net.link.LinkProvider;
71import org.onosproject.net.link.LinkProviderRegistry;
72import org.onosproject.net.link.LinkProviderService;
Thomas Vachuskae4ebac92015-09-10 11:39:05 -070073import org.onosproject.net.link.LinkService;
Brian O'Connorabafb502014-12-02 22:26:20 -080074import org.onosproject.net.packet.PacketContext;
Jonathan Hart3cfce8e2015-01-14 16:43:27 -080075import org.onosproject.net.packet.PacketPriority;
Brian O'Connorabafb502014-12-02 22:26:20 -080076import org.onosproject.net.packet.PacketProcessor;
77import org.onosproject.net.packet.PacketService;
78import org.onosproject.net.provider.AbstractProvider;
79import org.onosproject.net.provider.ProviderId;
Yuta HIGUCHI41289382014-12-19 17:47:12 -080080import org.osgi.service.component.ComponentContext;
alshabib7911a052014-10-16 17:49:37 -070081import org.slf4j.Logger;
82
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -080083import com.google.common.collect.ImmutableMap;
84import com.google.common.collect.ImmutableSet;
85import com.google.common.collect.Maps;
Yuta HIGUCHI41289382014-12-19 17:47:12 -080086
alshabib7911a052014-10-16 17:49:37 -070087/**
Thomas Vachuska05453c92015-09-09 14:40:49 -070088 * Provider which uses LLDP and BDDP packets to detect network infrastructure links.
alshabib7911a052014-10-16 17:49:37 -070089 */
90@Component(immediate = true)
Jonathan Hartb35540a2015-11-17 09:30:56 -080091public class LldpLinkProvider extends AbstractProvider implements LinkProvider {
alshabib7911a052014-10-16 17:49:37 -070092
Thomas Vachuskafc52fec2015-05-18 19:13:56 -070093 private static final String PROVIDER_NAME = "org.onosproject.provider.lldp";
94
Thomas Vachuska05453c92015-09-09 14:40:49 -070095 private static final String FORMAT =
96 "Settings: enabled={}, useBDDP={}, probeRate={}, " +
Naoki Shiota399a0b32015-11-15 20:36:13 -060097 "staleLinkAge={}";
Yuta HIGUCHI41289382014-12-19 17:47:12 -080098
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -070099 // When a Device/Port has this annotation, do not send out LLDP/BDDP
100 public static final String NO_LLDP = "no-lldp";
101
alshabib7911a052014-10-16 17:49:37 -0700102 private final Logger log = getLogger(getClass());
103
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -0800104 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
105 protected CoreService coreService;
106
107 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
alshabib7911a052014-10-16 17:49:37 -0700108 protected LinkProviderRegistry providerRegistry;
109
110 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
111 protected DeviceService deviceService;
112
113 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700114 protected LinkService linkService;
115
116 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Marc De Leenheer8b3e80b2015-03-06 14:27:03 -0800117 protected PacketService packetService;
alshabib7911a052014-10-16 17:49:37 -0700118
alshabib875d6262014-10-17 16:19:40 -0700119 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
120 protected MastershipService masterService;
121
Thomas Vachuska6519e6f2015-03-11 02:29:31 -0700122 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
123 protected ComponentConfigService cfgService;
124
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700125 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
126 protected ClusterService clusterService;
127
128 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
129 protected NetworkConfigRegistry cfgRegistry;
130
alshabib7911a052014-10-16 17:49:37 -0700131 private LinkProviderService providerService;
132
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800133 private ScheduledExecutorService executor;
134
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700135 // TODO: Add sanity checking for the configurable params based on the delays
136 private static final long DEVICE_SYNC_DELAY = 5;
137 private static final long LINK_PRUNER_DELAY = 3;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700138
139 private static final String PROP_ENABLED = "enabled";
140 @Property(name = PROP_ENABLED, boolValue = true,
141 label = "If false, link discovery is disabled")
142 private boolean enabled = false;
143
144 private static final String PROP_USE_BDDP = "useBDDP";
Thomas Vachuska6519e6f2015-03-11 02:29:31 -0700145 @Property(name = PROP_USE_BDDP, boolValue = true,
146 label = "Use BDDP for link discovery")
Jonathan Hartb35540a2015-11-17 09:30:56 -0800147 private boolean useBddp = true;
alshabib7911a052014-10-16 17:49:37 -0700148
Thomas Vachuska05453c92015-09-09 14:40:49 -0700149 private static final String PROP_PROBE_RATE = "probeRate";
150 private static final int DEFAULT_PROBE_RATE = 3_000;
151 @Property(name = PROP_PROBE_RATE, intValue = DEFAULT_PROBE_RATE,
152 label = "LLDP and BDDP probe rate specified in millis")
153 private int probeRate = DEFAULT_PROBE_RATE;
Saurav Dasc313c402015-02-27 10:09:47 -0800154
Thomas Vachuska05453c92015-09-09 14:40:49 -0700155 private static final String PROP_STALE_LINK_AGE = "staleLinkAge";
156 private static final int DEFAULT_STALE_LINK_AGE = 10_000;
157 @Property(name = PROP_STALE_LINK_AGE, intValue = DEFAULT_STALE_LINK_AGE,
158 label = "Number of millis beyond which links will be considered stale")
159 private int staleLinkAge = DEFAULT_STALE_LINK_AGE;
alshabib7911a052014-10-16 17:49:37 -0700160
Thomas Vachuska05453c92015-09-09 14:40:49 -0700161 private final DiscoveryContext context = new InternalDiscoveryContext();
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800162 private final InternalRoleListener roleListener = new InternalRoleListener();
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700163 private final InternalDeviceListener deviceListener = new InternalDeviceListener();
164 private final InternalPacketProcessor packetProcessor = new InternalPacketProcessor();
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800165
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700166 // Device link discovery helpers.
alshabib7911a052014-10-16 17:49:37 -0700167 protected final Map<DeviceId, LinkDiscovery> discoverers = new ConcurrentHashMap<>();
168
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700169 // Most recent time a tracked link was seen; links are tracked if their
170 // destination connection point is mastered by this controller instance.
171 private final Map<LinkKey, Long> linkTimes = Maps.newConcurrentMap();
172
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -0800173 private ApplicationId appId;
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800174
Naoki Shiota399a0b32015-11-15 20:36:13 -0600175 static final SuppressionRules DEFAULT_RULES
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800176 = new SuppressionRules(EnumSet.of(Device.Type.ROADM),
Naoki Shiota399a0b32015-11-15 20:36:13 -0600177 ImmutableMap.of(NO_LLDP, SuppressionRules.ANY_VALUE));
178
179 private SuppressionRules rules = LldpLinkProvider.DEFAULT_RULES;
180
181 public static final String CONFIG_KEY = "suppression";
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800182 public static final String FEATURE_NAME = "linkDiscovery";
Naoki Shiota399a0b32015-11-15 20:36:13 -0600183
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800184 private final Set<ConfigFactory<?, ?>> factories = ImmutableSet.of(
Naoki Shiota399a0b32015-11-15 20:36:13 -0600185 new ConfigFactory<ApplicationId, SuppressionConfig>(APP_SUBJECT_FACTORY,
186 SuppressionConfig.class,
187 CONFIG_KEY) {
188 @Override
189 public SuppressionConfig createConfig() {
190 return new SuppressionConfig();
191 }
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800192 },
193 new ConfigFactory<DeviceId, LinkDiscoveryFromDevice>(DEVICE_SUBJECT_FACTORY,
194 LinkDiscoveryFromDevice.class, FEATURE_NAME) {
195 @Override
196 public LinkDiscoveryFromDevice createConfig() {
197 return new LinkDiscoveryFromDevice();
198 }
199 },
200 new ConfigFactory<ConnectPoint, LinkDiscoveryFromPort>(CONNECT_POINT_SUBJECT_FACTORY,
201 LinkDiscoveryFromPort.class, FEATURE_NAME) {
202 @Override
203 public LinkDiscoveryFromPort createConfig() {
204 return new LinkDiscoveryFromPort();
205 }
Naoki Shiota399a0b32015-11-15 20:36:13 -0600206 }
207 );
208
209 private final InternalConfigListener cfgListener = new InternalConfigListener();
210
211
alshabib7911a052014-10-16 17:49:37 -0700212 /**
213 * Creates an OpenFlow link provider.
214 */
Jonathan Hartb35540a2015-11-17 09:30:56 -0800215 public LldpLinkProvider() {
Thomas Vachuskafc52fec2015-05-18 19:13:56 -0700216 super(new ProviderId("lldp", PROVIDER_NAME));
alshabib7911a052014-10-16 17:49:37 -0700217 }
218
219 @Activate
Saurav Dasc313c402015-02-27 10:09:47 -0800220 public void activate(ComponentContext context) {
Thomas Vachuska6519e6f2015-03-11 02:29:31 -0700221 cfgService.registerProperties(getClass());
Thomas Vachuskafc52fec2015-05-18 19:13:56 -0700222 appId = coreService.registerApplication(PROVIDER_NAME);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600223
224 cfgRegistry.addListener(cfgListener);
225 factories.forEach(cfgRegistry::registerConfigFactory);
226
227 SuppressionConfig cfg = cfgRegistry.getConfig(appId, SuppressionConfig.class);
228 if (cfg == null) {
229 // If no configuration is found, register default.
230 cfg = cfgRegistry.addConfig(appId, SuppressionConfig.class);
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800231 cfg.deviceTypes(DEFAULT_RULES.getSuppressedDeviceType())
Naoki Shiota399a0b32015-11-15 20:36:13 -0600232 .annotation(DEFAULT_RULES.getSuppressedAnnotation())
233 .apply();
234 }
235 cfgListener.reconfigureSuppressionRules(cfg);
236
Saurav Dasc313c402015-02-27 10:09:47 -0800237 modified(context);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700238 log.info("Started");
239 }
240
241 @Deactivate
242 public void deactivate() {
Naoki Shiota399a0b32015-11-15 20:36:13 -0600243 cfgRegistry.removeListener(cfgListener);
244 factories.forEach(cfgRegistry::unregisterConfigFactory);
245
Thomas Vachuska05453c92015-09-09 14:40:49 -0700246 cfgService.unregisterProperties(getClass(), false);
247 disable();
248 log.info("Stopped");
249 }
250
251 @Modified
252 public void modified(ComponentContext context) {
253 Dictionary<?, ?> properties = context != null ? context.getProperties() : new Properties();
254
255 boolean newEnabled, newUseBddp;
256 int newProbeRate, newStaleLinkAge;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700257 try {
258 String s = get(properties, PROP_ENABLED);
259 newEnabled = isNullOrEmpty(s) || Boolean.parseBoolean(s.trim());
260
261 s = get(properties, PROP_USE_BDDP);
262 newUseBddp = isNullOrEmpty(s) || Boolean.parseBoolean(s.trim());
263
264 s = get(properties, PROP_PROBE_RATE);
265 newProbeRate = isNullOrEmpty(s) ? probeRate : Integer.parseInt(s.trim());
266
267 s = get(properties, PROP_STALE_LINK_AGE);
268 newStaleLinkAge = isNullOrEmpty(s) ? staleLinkAge : Integer.parseInt(s.trim());
269
Thomas Vachuska05453c92015-09-09 14:40:49 -0700270 } catch (NumberFormatException e) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700271 log.warn("Component configuration had invalid values", e);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700272 newEnabled = enabled;
Jonathan Hartb35540a2015-11-17 09:30:56 -0800273 newUseBddp = useBddp;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700274 newProbeRate = probeRate;
275 newStaleLinkAge = staleLinkAge;
Saurav Dasc313c402015-02-27 10:09:47 -0800276 }
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800277
Thomas Vachuska05453c92015-09-09 14:40:49 -0700278 boolean wasEnabled = enabled;
279
280 enabled = newEnabled;
Jonathan Hartb35540a2015-11-17 09:30:56 -0800281 useBddp = newUseBddp;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700282 probeRate = newProbeRate;
283 staleLinkAge = newStaleLinkAge;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700284
285 if (!wasEnabled && enabled) {
286 enable();
287 } else if (wasEnabled && !enabled) {
288 disable();
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700289 } else {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700290 if (enabled) {
291 // update all discovery helper state
292 loadDevices();
293 }
Thomas Vachuska05453c92015-09-09 14:40:49 -0700294 }
295
Naoki Shiota399a0b32015-11-15 20:36:13 -0600296 log.info(FORMAT, enabled, useBddp, probeRate, staleLinkAge);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700297 }
298
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700299 /**
300 * Enables link discovery processing.
301 */
Thomas Vachuska05453c92015-09-09 14:40:49 -0700302 private void enable() {
alshabib7911a052014-10-16 17:49:37 -0700303 providerService = providerRegistry.register(this);
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800304 masterService.addListener(roleListener);
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700305 deviceService.addListener(deviceListener);
306 packetService.addProcessor(packetProcessor, PacketProcessor.advisor(0));
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800307
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700308 loadDevices();
Thomas Vachuska05453c92015-09-09 14:40:49 -0700309
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700310 executor = newSingleThreadScheduledExecutor(groupedThreads("onos/link", "discovery-%d"));
311 executor.scheduleAtFixedRate(new SyncDeviceInfoTask(),
312 DEVICE_SYNC_DELAY, DEVICE_SYNC_DELAY, SECONDS);
313 executor.scheduleAtFixedRate(new LinkPrunerTask(),
314 LINK_PRUNER_DELAY, LINK_PRUNER_DELAY, SECONDS);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700315
Thomas Vachuska05453c92015-09-09 14:40:49 -0700316 requestIntercepts();
317 }
318
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700319 /**
320 * Disables link discovery processing.
321 */
Thomas Vachuska05453c92015-09-09 14:40:49 -0700322 private void disable() {
323 withdrawIntercepts();
324
325 providerRegistry.unregister(this);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700326 masterService.removeListener(roleListener);
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700327 deviceService.removeListener(deviceListener);
328 packetService.removeProcessor(packetProcessor);
Thomas Vachuska05453c92015-09-09 14:40:49 -0700329
Naoki Shiota399a0b32015-11-15 20:36:13 -0600330
Thomas Vachuska05453c92015-09-09 14:40:49 -0700331 if (executor != null) {
332 executor.shutdownNow();
333 }
334 discoverers.values().forEach(LinkDiscovery::stop);
335 discoverers.clear();
336
337 providerService = null;
338 }
339
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700340 /**
341 * Loads available devices and registers their ports to be probed.
342 */
343 private void loadDevices() {
Naoki Shiota399a0b32015-11-15 20:36:13 -0600344 if (!enabled) {
345 return;
346 }
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700347 deviceService.getAvailableDevices()
348 .forEach(d -> updateDevice(d)
349 .ifPresent(ld -> updatePorts(ld, d.id())));
350 }
351
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800352 private boolean isBlacklisted(DeviceId did) {
353 LinkDiscoveryFromDevice cfg = cfgRegistry.getConfig(did, LinkDiscoveryFromDevice.class);
354 if (cfg == null) {
355 return false;
356 }
357 return !cfg.enabled();
358 }
359
360 private boolean isBlacklisted(ConnectPoint cp) {
361 // if parent device is blacklisted, so is the port
362 if (isBlacklisted(cp.deviceId())) {
363 return true;
364 }
365 LinkDiscoveryFromPort cfg = cfgRegistry.getConfig(cp, LinkDiscoveryFromPort.class);
366 if (cfg == null) {
367 return false;
368 }
369 return !cfg.enabled();
370 }
371
372 private boolean isBlacklisted(Port port) {
373 return isBlacklisted(new ConnectPoint(port.element().id(), port.number()));
374 }
375
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700376 /**
377 * Updates discovery helper for specified device.
378 *
379 * Adds and starts a discovery helper for specified device if enabled,
380 * calls {@link #removeDevice(DeviceId)} otherwise.
381 *
382 * @param device device to add
383 * @return discovery helper if discovery is enabled for the device
384 */
385 private Optional<LinkDiscovery> updateDevice(Device device) {
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800386 if (device == null) {
387 return Optional.empty();
388 }
389 if (rules.isSuppressed(device) || isBlacklisted(device.id())) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700390 log.trace("LinkDiscovery from {} disabled by configuration", device.id());
391 removeDevice(device.id());
392 return Optional.empty();
393 }
394 LinkDiscovery ld = discoverers.computeIfAbsent(device.id(),
395 did -> new LinkDiscovery(device, context));
396 if (ld.isStopped()) {
397 ld.start();
398 }
399 return Optional.of(ld);
400 }
401
402 /**
403 * Removes after stopping discovery helper for specified device.
404 * @param deviceId device to remove
405 */
406 private void removeDevice(final DeviceId deviceId) {
407 discoverers.computeIfPresent(deviceId, (did, ld) -> {
408 ld.stop();
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700409 return null;
410 });
411
412 }
413
414 /**
415 * Updates ports of the specified device to the specified discovery helper.
416 */
417 private void updatePorts(LinkDiscovery discoverer, DeviceId deviceId) {
418 deviceService.getPorts(deviceId).forEach(p -> updatePort(discoverer, p));
419 }
420
421 /**
422 * Updates discovery helper state of the specified port.
423 *
424 * Adds a port to the discovery helper if up and discovery is enabled,
425 * or calls {@link #removePort(Port)} otherwise.
426 */
427 private void updatePort(LinkDiscovery discoverer, Port port) {
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800428 if (port == null) {
429 return;
430 }
HIGUCHI Yutab853b3f2015-11-17 18:43:20 -0800431 if (port.number().isLogical()) {
432 // silently ignore logical ports
433 return;
434 }
Naoki Shiota399a0b32015-11-15 20:36:13 -0600435
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800436 if (rules.isSuppressed(port) || isBlacklisted(port)) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700437 log.trace("LinkDiscovery from {} disabled by configuration", port);
438 removePort(port);
439 return;
440 }
441
442 // check if enabled and turn off discovery?
443 if (!port.isEnabled()) {
444 removePort(port);
445 return;
446 }
447
HIGUCHI Yutab853b3f2015-11-17 18:43:20 -0800448 discoverer.addPort(port);
alshabib7911a052014-10-16 17:49:37 -0700449 }
450
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700451 /**
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700452 * Removes a port from the specified discovery helper.
453 * @param port the port
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700454 */
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700455 private void removePort(Port port) {
456 if (port.element() instanceof Device) {
457 Device d = (Device) port.element();
458 LinkDiscovery ld = discoverers.get(d.id());
459 if (ld != null) {
460 ld.removePort(port.number());
Jonathan Hart45066bc2015-07-28 11:18:34 -0700461 }
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700462 } else {
463 log.warn("Attempted to remove non-Device port", port);
Jonathan Hart45066bc2015-07-28 11:18:34 -0700464 }
465 }
466
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700467 /**
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700468 * Requests packet intercepts.
Charles M.C. Chane148de82015-05-06 12:38:21 +0800469 */
Thomas Vachuska27bee092015-06-23 19:03:10 -0700470 private void requestIntercepts() {
471 TrafficSelector.Builder selector = DefaultTrafficSelector.builder();
Thomas Vachuska347cc872015-09-23 10:25:29 -0700472 selector.matchEthType(TYPE_LLDP);
Thomas Vachuska27bee092015-06-23 19:03:10 -0700473 packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId);
Jonathan Hart3cfce8e2015-01-14 16:43:27 -0800474
Thomas Vachuska347cc872015-09-23 10:25:29 -0700475 selector.matchEthType(TYPE_BSN);
Jonathan Hartb35540a2015-11-17 09:30:56 -0800476 if (useBddp) {
Thomas Vachuska27bee092015-06-23 19:03:10 -0700477 packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId);
478 } else {
479 packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId);
Pavlin Radoslavovd36a74b2015-01-09 11:59:07 -0800480 }
481 }
482
Thomas Vachuska27bee092015-06-23 19:03:10 -0700483 /**
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700484 * Withdraws packet intercepts.
Thomas Vachuska27bee092015-06-23 19:03:10 -0700485 */
486 private void withdrawIntercepts() {
487 TrafficSelector.Builder selector = DefaultTrafficSelector.builder();
Thomas Vachuska347cc872015-09-23 10:25:29 -0700488 selector.matchEthType(TYPE_LLDP);
Thomas Vachuska27bee092015-06-23 19:03:10 -0700489 packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId);
Thomas Vachuska347cc872015-09-23 10:25:29 -0700490 selector.matchEthType(TYPE_BSN);
Thomas Vachuska27bee092015-06-23 19:03:10 -0700491 packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId);
492 }
493
Naoki Shiota399a0b32015-11-15 20:36:13 -0600494 protected SuppressionRules rules() {
495 return rules;
496 }
497
498 protected void updateRules(SuppressionRules newRules) {
499 if (!rules.equals(newRules)) {
500 rules = newRules;
501 loadDevices();
502 }
503 }
504
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700505 /**
506 * Processes device mastership role changes.
507 */
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800508 private class InternalRoleListener implements MastershipListener {
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800509 @Override
510 public void event(MastershipEvent event) {
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800511 if (MastershipEvent.Type.BACKUPS_CHANGED.equals(event.type())) {
512 // only need new master events
513 return;
514 }
515
516 DeviceId deviceId = event.subject();
517 Device device = deviceService.getDevice(deviceId);
518 if (device == null) {
Thomas Vachuska3358af22015-05-19 18:40:34 -0700519 log.debug("Device {} doesn't exist, or isn't there yet", deviceId);
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800520 return;
521 }
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700522 if (clusterService.getLocalNode().id().equals(event.roleInfo().master())) {
523 updateDevice(device).ifPresent(ld -> updatePorts(ld, device.id()));
Yuta HIGUCHI41289382014-12-19 17:47:12 -0800524 }
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800525 }
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800526 }
alshabib7911a052014-10-16 17:49:37 -0700527
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700528 /**
529 * Processes device events.
530 */
531 private class InternalDeviceListener implements DeviceListener {
alshabib7911a052014-10-16 17:49:37 -0700532 @Override
533 public void event(DeviceEvent event) {
alshabib7911a052014-10-16 17:49:37 -0700534 Device device = event.subject();
alshabibacd91832014-10-17 14:38:41 -0700535 Port port = event.port();
alshabibdfc7afb2014-10-21 20:13:27 -0700536 if (device == null) {
537 log.error("Device is null.");
538 return;
539 }
Yuta HIGUCHIeb24e9d2014-10-26 19:34:20 -0700540 log.trace("{} {} {}", event.type(), event.subject(), event);
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700541 final DeviceId deviceId = device.id();
alshabib7911a052014-10-16 17:49:37 -0700542 switch (event.type()) {
543 case DEVICE_ADDED:
Yuta HIGUCHIeb24e9d2014-10-26 19:34:20 -0700544 case DEVICE_UPDATED:
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700545 updateDevice(device).ifPresent(ld -> updatePorts(ld, deviceId));
alshabib7911a052014-10-16 17:49:37 -0700546 break;
547 case PORT_ADDED:
548 case PORT_UPDATED:
Yuta HIGUCHIf6725882014-10-29 15:25:51 -0700549 if (port.isEnabled()) {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700550 updateDevice(device).ifPresent(ld -> updatePort(ld, port));
alshabib7911a052014-10-16 17:49:37 -0700551 } else {
Yuta HIGUCHIf6725882014-10-29 15:25:51 -0700552 log.debug("Port down {}", port);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700553 removePort(port);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600554 providerService.linksVanished(new ConnectPoint(port.element().id(),
555 port.number()));
alshabib7911a052014-10-16 17:49:37 -0700556 }
557 break;
558 case PORT_REMOVED:
Yuta HIGUCHIeb24e9d2014-10-26 19:34:20 -0700559 log.debug("Port removed {}", port);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700560 removePort(port);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600561 providerService.linksVanished(new ConnectPoint(port.element().id(),
562 port.number()));
alshabib7911a052014-10-16 17:49:37 -0700563 break;
564 case DEVICE_REMOVED:
565 case DEVICE_SUSPENDED:
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700566 log.debug("Device removed {}", deviceId);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700567 removeDevice(deviceId);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600568 providerService.linksVanished(deviceId);
alshabib7911a052014-10-16 17:49:37 -0700569 break;
570 case DEVICE_AVAILABILITY_CHANGED:
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700571 if (deviceService.isAvailable(deviceId)) {
572 log.debug("Device up {}", deviceId);
alshabibe3af2652015-12-01 23:05:34 -0800573 updateDevice(device).ifPresent(ld -> updatePorts(ld, deviceId));
alshabib7911a052014-10-16 17:49:37 -0700574 } else {
Yuta HIGUCHId19f6702014-10-31 15:23:25 -0700575 log.debug("Device down {}", deviceId);
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700576 removeDevice(deviceId);
Naoki Shiota399a0b32015-11-15 20:36:13 -0600577 providerService.linksVanished(deviceId);
alshabib7911a052014-10-16 17:49:37 -0700578 }
579 break;
Jonathan Hart9de692c2015-04-23 11:45:47 -0700580 case PORT_STATS_UPDATED:
581 break;
alshabib7911a052014-10-16 17:49:37 -0700582 default:
583 log.debug("Unknown event {}", event);
584 }
585 }
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700586 }
alshabib7911a052014-10-16 17:49:37 -0700587
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700588 /**
589 * Processes incoming packets.
590 */
591 private class InternalPacketProcessor implements PacketProcessor {
alshabib7911a052014-10-16 17:49:37 -0700592 @Override
593 public void process(PacketContext context) {
Thomas Vachuska347cc872015-09-23 10:25:29 -0700594 if (context == null || context.isHandled()) {
alshabib4a179dc2014-10-17 17:17:01 -0700595 return;
596 }
Thomas Vachuska347cc872015-09-23 10:25:29 -0700597
598 Ethernet eth = context.inPacket().parsed();
599 if (eth == null || (eth.getEtherType() != TYPE_LLDP && eth.getEtherType() != TYPE_BSN)) {
600 return;
601 }
602
Thomas Vachuska96f3ea72015-09-08 13:50:12 -0700603 LinkDiscovery ld = discoverers.get(context.inPacket().receivedFrom().deviceId());
alshabib7911a052014-10-16 17:49:37 -0700604 if (ld == null) {
605 return;
606 }
607
Jonathan Hartb35540a2015-11-17 09:30:56 -0800608 if (ld.handleLldp(context)) {
alshabib7911a052014-10-16 17:49:37 -0700609 context.block();
610 }
611 }
612 }
613
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700614 /**
615 * Auxiliary task to keep device ports up to date.
616 */
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800617 private final class SyncDeviceInfoTask implements Runnable {
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800618 @Override
619 public void run() {
620 if (Thread.currentThread().isInterrupted()) {
621 log.info("Interrupted, quitting");
622 return;
623 }
624 // check what deviceService sees, to see if we are missing anything
625 try {
HIGUCHI Yuta9a9edf82015-10-21 11:23:20 -0700626 loadDevices();
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800627 } catch (Exception e) {
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700628 // Catch all exceptions to avoid task being suppressed
Ayaka Koshibeccfa94c2014-11-20 11:15:52 -0800629 log.error("Exception thrown during synchronization process", e);
630 }
631 }
632 }
633
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700634 /**
635 * Auxiliary task for pruning stale links.
636 */
637 private class LinkPrunerTask implements Runnable {
638 @Override
639 public void run() {
640 if (Thread.currentThread().isInterrupted()) {
641 log.info("Interrupted, quitting");
642 return;
643 }
644
645 try {
646 // TODO: There is still a slight possibility of mastership
647 // change occurring right with link going stale. This will
648 // result in the stale link not being pruned.
649 Maps.filterEntries(linkTimes, e -> {
650 if (!masterService.isLocalMaster(e.getKey().dst().deviceId())) {
651 return true;
652 }
653 if (isStale(e.getValue())) {
654 providerService.linkVanished(new DefaultLinkDescription(e.getKey().src(),
655 e.getKey().dst(),
656 DIRECT));
657 return true;
658 }
659 return false;
660 }).clear();
661
662 } catch (Exception e) {
663 // Catch all exceptions to avoid task being suppressed
664 log.error("Exception thrown during link pruning process", e);
665 }
666 }
667
668 private boolean isStale(long lastSeen) {
669 return lastSeen < System.currentTimeMillis() - staleLinkAge;
670 }
671 }
672
673 /**
674 * Provides processing context for the device link discovery helpers.
675 */
Thomas Vachuska05453c92015-09-09 14:40:49 -0700676 private class InternalDiscoveryContext implements DiscoveryContext {
677 @Override
678 public MastershipService mastershipService() {
679 return masterService;
680 }
681
682 @Override
683 public LinkProviderService providerService() {
684 return providerService;
685 }
686
687 @Override
688 public PacketService packetService() {
689 return packetService;
690 }
691
692 @Override
693 public long probeRate() {
694 return probeRate;
695 }
696
697 @Override
Jonathan Hartb35540a2015-11-17 09:30:56 -0800698 public boolean useBddp() {
699 return useBddp;
Thomas Vachuska05453c92015-09-09 14:40:49 -0700700 }
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700701
702 @Override
703 public void touchLink(LinkKey key) {
704 linkTimes.put(key, System.currentTimeMillis());
705 }
Thomas Vachuska05453c92015-09-09 14:40:49 -0700706 }
Thomas Vachuskae4ebac92015-09-10 11:39:05 -0700707
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800708 static final EnumSet<NetworkConfigEvent.Type> CONFIG_CHANGED
709 = EnumSet.of(NetworkConfigEvent.Type.CONFIG_ADDED,
710 NetworkConfigEvent.Type.CONFIG_UPDATED,
711 NetworkConfigEvent.Type.CONFIG_REMOVED);
712
Naoki Shiota399a0b32015-11-15 20:36:13 -0600713 private class InternalConfigListener implements NetworkConfigListener {
714
715 private synchronized void reconfigureSuppressionRules(SuppressionConfig cfg) {
716 if (cfg == null) {
717 log.error("Suppression Config is null.");
718 return;
719 }
720
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800721 SuppressionRules newRules = new SuppressionRules(cfg.deviceTypes(),
Naoki Shiota399a0b32015-11-15 20:36:13 -0600722 cfg.annotation());
723
724 updateRules(newRules);
725 }
726
727 @Override
728 public void event(NetworkConfigEvent event) {
HIGUCHI Yutad9fe3a32015-11-24 18:52:25 -0800729 if (event.configClass() == LinkDiscoveryFromDevice.class &&
730 CONFIG_CHANGED.contains(event.type())) {
731
732 if (event.subject() instanceof DeviceId) {
733 final DeviceId did = (DeviceId) event.subject();
734 Device device = deviceService.getDevice(did);
735 updateDevice(device).ifPresent(ld -> updatePorts(ld, did));
736 }
737
738 } else if (event.configClass() == LinkDiscoveryFromPort.class &&
739 CONFIG_CHANGED.contains(event.type())) {
740
741 if (event.subject() instanceof ConnectPoint) {
742 ConnectPoint cp = (ConnectPoint) event.subject();
743 if (cp.elementId() instanceof DeviceId) {
744 final DeviceId did = (DeviceId) cp.elementId();
745 Device device = deviceService.getDevice(did);
746 Port port = deviceService.getPort(did, cp.port());
747 updateDevice(device).ifPresent(ld -> updatePort(ld, port));
748 }
749 }
750
751 } else if (event.configClass().equals(SuppressionConfig.class) &&
Naoki Shiota399a0b32015-11-15 20:36:13 -0600752 (event.type() == NetworkConfigEvent.Type.CONFIG_ADDED ||
753 event.type() == NetworkConfigEvent.Type.CONFIG_UPDATED)) {
754 SuppressionConfig cfg = cfgRegistry.getConfig(appId, SuppressionConfig.class);
755 reconfigureSuppressionRules(cfg);
756 log.trace("Network config reconfigured");
757 }
758 }
759 }
alshabib7911a052014-10-16 17:49:37 -0700760}