2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.protocol_plugin.openflow.internal;
11 import java.util.ArrayList;
12 import java.util.Date;
13 import java.util.HashSet;
14 import java.util.List;
17 import java.util.concurrent.ConcurrentHashMap;
18 import java.util.concurrent.ConcurrentMap;
19 import java.util.concurrent.CopyOnWriteArrayList;
20 import java.util.concurrent.CopyOnWriteArraySet;
22 import org.opendaylight.controller.protocol_plugin.openflow.IInventoryShimExternalListener;
23 import org.opendaylight.controller.protocol_plugin.openflow.IInventoryShimInternalListener;
24 import org.opendaylight.controller.protocol_plugin.openflow.IOFStatisticsListener;
25 import org.opendaylight.controller.protocol_plugin.openflow.core.IController;
26 import org.opendaylight.controller.protocol_plugin.openflow.core.IMessageListener;
27 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitch;
28 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitchStateListener;
29 import org.opendaylight.controller.sal.connection.IPluginOutConnectionService;
30 import org.opendaylight.controller.sal.core.Actions;
31 import org.opendaylight.controller.sal.core.Buffers;
32 import org.opendaylight.controller.sal.core.Capabilities;
33 import org.opendaylight.controller.sal.core.ContainerFlow;
34 import org.opendaylight.controller.sal.core.Description;
35 import org.opendaylight.controller.sal.core.IContainerAware;
36 import org.opendaylight.controller.sal.core.IContainerListener;
37 import org.opendaylight.controller.sal.core.MacAddress;
38 import org.opendaylight.controller.sal.core.Node;
39 import org.opendaylight.controller.sal.core.NodeConnector;
40 import org.opendaylight.controller.sal.core.Property;
41 import org.opendaylight.controller.sal.core.Tables;
42 import org.opendaylight.controller.sal.core.TimeStamp;
43 import org.opendaylight.controller.sal.core.UpdateType;
44 import org.opendaylight.controller.sal.utils.GlobalConstants;
45 import org.opendaylight.controller.sal.utils.NodeCreator;
46 import org.openflow.protocol.OFMessage;
47 import org.openflow.protocol.OFPortStatus;
48 import org.openflow.protocol.OFPortStatus.OFPortReason;
49 import org.openflow.protocol.OFType;
50 import org.openflow.protocol.statistics.OFDescriptionStatistics;
51 import org.openflow.protocol.statistics.OFStatistics;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
56 * The class describes a shim layer that bridges inventory events from Openflow
57 * core to various listeners. The notifications are filtered based on container
62 public class InventoryServiceShim implements IContainerListener,
63 IMessageListener, ISwitchStateListener, IOFStatisticsListener, IContainerAware {
64 protected static final Logger logger = LoggerFactory
65 .getLogger(InventoryServiceShim.class);
66 private IController controller = null;
67 private final ConcurrentMap<String, IInventoryShimInternalListener> inventoryShimInternalListeners = new ConcurrentHashMap<String, IInventoryShimInternalListener>();
68 private final Set<IInventoryShimInternalListener> globalInventoryShimInternalListeners = new HashSet<IInventoryShimInternalListener>();
69 private final List<IInventoryShimExternalListener> inventoryShimExternalListeners = new CopyOnWriteArrayList<IInventoryShimExternalListener>();
70 private final ConcurrentMap<NodeConnector, Set<String>> nodeConnectorContainerMap = new ConcurrentHashMap<NodeConnector, Set<String>>();
71 private final ConcurrentMap<Node, Set<String>> nodeContainerMap = new ConcurrentHashMap<Node, Set<String>>();
72 private final ConcurrentMap<NodeConnector, Set<Property>> nodeConnectorProps = new ConcurrentHashMap<NodeConnector, Set<Property>>();
73 private final ConcurrentMap<Node, Set<Property>> nodeProps = new ConcurrentHashMap<Node, Set<Property>>();
74 private IPluginOutConnectionService connectionOutService;
76 void setController(IController s) {
80 void unsetController(IController s) {
81 if (this.controller == s) {
82 this.controller = null;
86 void setInventoryShimGlobalInternalListener(Map<?, ?> props,
87 IInventoryShimInternalListener s) {
88 if ((this.globalInventoryShimInternalListeners != null)) {
89 this.globalInventoryShimInternalListeners.add(s);
93 void unsetInventoryShimGlobalInternalListener(Map<?, ?> props,
94 IInventoryShimInternalListener s) {
95 if ((this.globalInventoryShimInternalListeners != null)) {
96 this.globalInventoryShimInternalListeners.remove(s);
100 void setInventoryShimInternalListener(Map<?, ?> props,
101 IInventoryShimInternalListener s) {
103 logger.error("setInventoryShimInternalListener property is null");
106 String containerName = (String) props.get("containerName");
107 if (containerName == null) {
108 logger.error("setInventoryShimInternalListener containerName not supplied");
111 if ((this.inventoryShimInternalListeners != null)
112 && !this.inventoryShimInternalListeners.containsValue(s)) {
113 this.inventoryShimInternalListeners.put(containerName, s);
115 "Added inventoryShimInternalListener for container {}",
120 void unsetInventoryShimInternalListener(Map<?, ?> props,
121 IInventoryShimInternalListener s) {
123 logger.error("unsetInventoryShimInternalListener property is null");
126 String containerName = (String) props.get("containerName");
127 if (containerName == null) {
128 logger.error("setInventoryShimInternalListener containerName not supplied");
131 if ((this.inventoryShimInternalListeners != null)
132 && this.inventoryShimInternalListeners.get(containerName) != null
133 && this.inventoryShimInternalListeners.get(containerName)
135 this.inventoryShimInternalListeners.remove(containerName);
137 "Removed inventoryShimInternalListener for container {}",
142 void setInventoryShimExternalListener(IInventoryShimExternalListener s) {
143 logger.trace("Set inventoryShimExternalListener {}", s);
144 if ((this.inventoryShimExternalListeners != null)
145 && !this.inventoryShimExternalListeners.contains(s)) {
146 this.inventoryShimExternalListeners.add(s);
150 void unsetInventoryShimExternalListener(IInventoryShimExternalListener s) {
151 logger.trace("Unset inventoryShimExternalListener {}", s);
152 if ((this.inventoryShimExternalListeners != null)
153 && this.inventoryShimExternalListeners.contains(s)) {
154 this.inventoryShimExternalListeners.remove(s);
158 void setIPluginOutConnectionService(IPluginOutConnectionService s) {
159 connectionOutService = s;
162 void unsetIPluginOutConnectionService(IPluginOutConnectionService s) {
163 if (connectionOutService == s) {
164 connectionOutService = null;
169 * Function called by the dependency manager when all the required
170 * dependencies are satisfied
174 this.controller.addMessageListener(OFType.PORT_STATUS, this);
175 this.controller.addSwitchStateListener(this);
179 * Function called after registering the service in OSGi service registry.
182 /* Start with existing switches */
187 * Function called by the dependency manager when at least one dependency
188 * become unsatisfied or when the component is shutting down because for
189 * example bundle is being stopped.
193 this.controller.removeMessageListener(OFType.PACKET_IN, this);
194 this.controller.removeSwitchStateListener(this);
196 this.inventoryShimInternalListeners.clear();
197 this.nodeConnectorContainerMap.clear();
198 this.nodeContainerMap.clear();
199 this.globalInventoryShimInternalListeners.clear();
200 this.controller = null;
204 public void receive(ISwitch sw, OFMessage msg) {
205 if (msg instanceof OFPortStatus) {
206 handlePortStatusMessage(sw, (OFPortStatus) msg);
211 protected void handlePortStatusMessage(ISwitch sw, OFPortStatus m) {
212 Node node = NodeCreator.createOFNode(sw.getId());
213 NodeConnector nodeConnector = PortConverter.toNodeConnector(
214 m.getDesc().getPortNumber(), node);
215 // get node connector properties
216 Set<Property> props = InventoryServiceHelper.OFPortToProps(m.getDesc());
218 UpdateType type = null;
219 if (m.getReason() == (byte) OFPortReason.OFPPR_ADD.ordinal()) {
220 type = UpdateType.ADDED;
221 nodeConnectorProps.put(nodeConnector, props);
222 } else if (m.getReason() == (byte) OFPortReason.OFPPR_DELETE.ordinal()) {
223 type = UpdateType.REMOVED;
224 nodeConnectorProps.remove(nodeConnector);
225 } else if (m.getReason() == (byte) OFPortReason.OFPPR_MODIFY.ordinal()) {
226 type = UpdateType.CHANGED;
227 nodeConnectorProps.put(nodeConnector, props);
230 logger.trace("handlePortStatusMessage {} type {}", nodeConnector, type);
233 notifyInventoryShimListener(nodeConnector, type, props);
238 public void switchAdded(ISwitch sw) {
243 // Add all the nodeConnectors of this switch
244 Map<NodeConnector, Set<Property>> ncProps = InventoryServiceHelper
245 .OFSwitchToProps(sw);
246 for (Map.Entry<NodeConnector, Set<Property>> entry : ncProps.entrySet()) {
247 Set<Property> props = new HashSet<Property>();
248 Set<Property> prop = entry.getValue();
252 nodeConnectorProps.put(entry.getKey(), props);
253 notifyInventoryShimListener(entry.getKey(), UpdateType.ADDED,
262 public void switchDeleted(ISwitch sw) {
271 public void containerModeUpdated(UpdateType t) {
276 public void tagUpdated(String containerName, Node n, short oldTag,
277 short newTag, UpdateType t) {
278 logger.debug("tagUpdated: {} type {} for container {}", new Object[] {
279 n, t, containerName });
283 public void containerFlowUpdated(String containerName,
284 ContainerFlow previousFlow, ContainerFlow currentFlow, UpdateType t) {
288 public void nodeConnectorUpdated(String containerName, NodeConnector nc, UpdateType t) {
289 logger.debug("nodeConnectorUpdated: {} type {} for container {}", new Object[] { nc, t, containerName });
290 Node node = nc.getNode();
291 Set<String> ncContainers = this.nodeConnectorContainerMap.get(nc);
292 Set<String> nodeContainers = this.nodeContainerMap.get(node);
293 if (ncContainers == null) {
294 ncContainers = new CopyOnWriteArraySet<String>();
296 if (nodeContainers == null) {
297 nodeContainers = new CopyOnWriteArraySet<String>();
299 boolean notifyNodeUpdate = false;
303 if (ncContainers.add(containerName)) {
304 this.nodeConnectorContainerMap.put(nc, ncContainers);
306 if (nodeContainers.add(containerName)) {
307 this.nodeContainerMap.put(node, nodeContainers);
308 notifyNodeUpdate = true;
312 if (ncContainers.remove(containerName)) {
313 if (ncContainers.isEmpty()) {
314 // Do cleanup to reduce memory footprint if no
315 // elements to be tracked
316 this.nodeConnectorContainerMap.remove(nc);
318 this.nodeConnectorContainerMap.put(nc, ncContainers);
321 boolean nodeContainerUpdate = true;
322 for (NodeConnector ncContainer : nodeConnectorContainerMap.keySet()) {
323 if ((ncContainer.getNode().equals(node)) && (nodeConnectorContainerMap.get(ncContainer).contains(containerName))) {
324 nodeContainerUpdate = false;
328 if (nodeContainerUpdate) {
329 nodeContainers.remove(containerName);
330 notifyNodeUpdate = true;
331 if (nodeContainers.isEmpty()) {
332 this.nodeContainerMap.remove(node);
334 this.nodeContainerMap.put(node, nodeContainers);
342 Set<Property> nodeProp = nodeProps.get(node);
343 if (nodeProp == null) {
346 Set<Property> ncProp = nodeConnectorProps.get(nc);
347 // notify InventoryService
348 notifyInventoryShimInternalListener(containerName, nc, t, ncProp);
350 if (notifyNodeUpdate) {
351 notifyInventoryShimInternalListener(containerName, node, t, nodeProp);
355 private void notifyInventoryShimExternalListener(Node node,
356 UpdateType type, Set<Property> props) {
357 for (IInventoryShimExternalListener s : this.inventoryShimExternalListeners) {
358 s.updateNode(node, type, props);
362 private void notifyInventoryShimExternalListener(
363 NodeConnector nodeConnector, UpdateType type, Set<Property> props) {
364 for (IInventoryShimExternalListener s : this.inventoryShimExternalListeners) {
365 s.updateNodeConnector(nodeConnector, type, props);
369 private void notifyInventoryShimInternalListener(String container,
370 NodeConnector nodeConnector, UpdateType type, Set<Property> props) {
371 IInventoryShimInternalListener inventoryShimInternalListener = inventoryShimInternalListeners
373 if (inventoryShimInternalListener != null) {
374 inventoryShimInternalListener.updateNodeConnector(nodeConnector,
377 "notifyInventoryShimInternalListener {} type {} for container {}",
378 new Object[] { nodeConnector, type, container });
383 * Notify all internal and external listeners
385 private void notifyInventoryShimListener(NodeConnector nodeConnector, UpdateType type, Set<Property> props) {
387 //establish locality before notifying
389 if (type == UpdateType.REMOVED){
390 //if removing get the locality first
391 isNodeLocal = connectionOutService.isLocal(nodeConnector.getNode());
392 notifyGlobalInventoryShimInternalListener(nodeConnector, type, props);
394 notifyGlobalInventoryShimInternalListener(nodeConnector, type, props);
395 isNodeLocal = connectionOutService.isLocal(nodeConnector.getNode());
399 // notify other containers
400 Set<String> containers = (nodeConnectorContainerMap.get(nodeConnector) == null) ? new HashSet<String>()
401 : new HashSet<String>(nodeConnectorContainerMap.get(nodeConnector));
402 containers.add(GlobalConstants.DEFAULT.toString());
403 for (String container : containers) {
404 notifyInventoryShimInternalListener(container, nodeConnector, type, props);
407 // Notify DiscoveryService
408 notifyInventoryShimExternalListener(nodeConnector, type, props);
410 logger.debug("Connection service accepted the inventory notification for {} {}", nodeConnector, type);
412 logger.debug("Connection service dropped the inventory notification for {} {}", nodeConnector, type);
417 * Notify all internal and external listeners
419 private void notifyInventoryShimListener(Node node, UpdateType type, Set<Property> props) {
421 //establish locality before notifying
423 if (type == UpdateType.REMOVED){
424 //if removing get the locality first
425 isNodeLocal = connectionOutService.isLocal(node);
426 notifyGlobalInventoryShimInternalListener(node, type, props);
428 notifyGlobalInventoryShimInternalListener(node, type, props);
429 isNodeLocal = connectionOutService.isLocal(node);
433 // Now notify other containers
434 Set<String> containers = (nodeContainerMap.get(node) == null) ? new HashSet<String>() : new HashSet<String>(
435 nodeContainerMap.get(node));
436 containers.add(GlobalConstants.DEFAULT.toString());
437 for (String container : containers) {
438 notifyInventoryShimInternalListener(container, node, type, props);
441 // Notify external listener
442 notifyInventoryShimExternalListener(node, type, props);
444 logger.debug("Connection service accepted the inventory notification for {} {}", node, type);
446 logger.debug("Connection service dropped the inventory notification for {} {}", node, type);
450 private void notifyGlobalInventoryShimInternalListener(Node node, UpdateType type, Set<Property> props) {
451 for (IInventoryShimInternalListener globalListener : globalInventoryShimInternalListeners) {
452 globalListener.updateNode(node, type, props);
454 "notifyGlobalInventoryShimInternalListener {} type {}",
455 new Object[] { node, type });
459 private void notifyGlobalInventoryShimInternalListener(NodeConnector nodeConnector, UpdateType type, Set<Property> props) {
460 for (IInventoryShimInternalListener globalListener : globalInventoryShimInternalListeners) {
461 globalListener.updateNodeConnector(nodeConnector, type, props);
463 "notifyGlobalInventoryShimInternalListener {} type {}",
464 new Object[] { nodeConnector, type });
468 private void notifyInventoryShimInternalListener(String container,
469 Node node, UpdateType type, Set<Property> props) {
470 IInventoryShimInternalListener inventoryShimInternalListener = inventoryShimInternalListeners
472 if (inventoryShimInternalListener != null) {
473 inventoryShimInternalListener.updateNode(node, type, props);
475 "notifyInventoryShimInternalListener {} type {} for container {}",
476 new Object[] { node, type, container });
480 private void addNode(ISwitch sw) {
481 Node node = NodeCreator.createOFNode(sw.getId());
482 UpdateType type = UpdateType.ADDED;
484 Set<Property> props = new HashSet<Property>();
485 Long sid = (Long) node.getID();
487 Date connectedSince = controller.getSwitches().get(sid)
489 Long connectedSinceTime = (connectedSince == null) ? 0 : connectedSince
491 props.add(new TimeStamp(connectedSinceTime, "connectedSince"));
492 props.add(new MacAddress(deriveMacAddress(sid)));
494 byte tables = sw.getTables();
495 Tables t = new Tables(tables);
499 int cap = sw.getCapabilities();
500 Capabilities c = new Capabilities(cap);
504 int act = sw.getActions();
505 Actions a = new Actions(act);
509 int buffers = sw.getBuffers();
510 Buffers b = new Buffers(buffers);
515 nodeProps.put(node, props);
516 // Notify all internal and external listeners
517 notifyInventoryShimListener(node, type, props);
520 private void removeNode(ISwitch sw) {
521 Node node = NodeCreator.createOFNode(sw.getId());
525 removeNodeConnectorProps(node);
526 nodeProps.remove(node);
527 UpdateType type = UpdateType.REMOVED;
528 // Notify all internal and external listeners
529 notifyInventoryShimListener(node, type, null);
532 private void startService() {
533 // Get a snapshot of all the existing switches
534 Map<Long, ISwitch> switches = this.controller.getSwitches();
535 for (ISwitch sw : switches.values()) {
540 private void removeNodeConnectorProps(Node node) {
541 List<NodeConnector> ncList = new ArrayList<NodeConnector>();
542 for (NodeConnector nc : nodeConnectorProps.keySet()) {
543 if (nc.getNode().equals(node)) {
547 for (NodeConnector nc : ncList) {
548 nodeConnectorProps.remove(nc);
553 public void descriptionStatisticsRefreshed(Long switchId, List<OFStatistics> descriptionStats) {
554 Node node = NodeCreator.createOFNode(switchId);
555 Set<Property> properties = new HashSet<Property>(1);
556 OFDescriptionStatistics ofDesc = (OFDescriptionStatistics) descriptionStats.get(0);
557 Description desc = new Description(ofDesc.getDatapathDescription());
558 properties.add(desc);
560 // Notify all internal and external listeners
561 notifyInventoryShimListener(node, UpdateType.CHANGED, properties);
564 private byte[] deriveMacAddress(long dpid) {
565 byte[] mac = new byte[] { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
567 for (short i = 0; i < 6; i++) {
568 mac[5 - i] = (byte) dpid;
576 public void flowStatisticsRefreshed(Long switchId, List<OFStatistics> flows) {
581 public void portStatisticsRefreshed(Long switchId, List<OFStatistics> ports) {
586 public void tableStatisticsRefreshed(Long switchId, List<OFStatistics> tables) {
591 public void containerCreate(String containerName) {
596 public void containerDestroy(String containerName) {
597 Set<NodeConnector> removeNodeConnectorSet = new HashSet<NodeConnector>();
598 Set<Node> removeNodeSet = new HashSet<Node>();
599 for (Map.Entry<NodeConnector, Set<String>> entry : nodeConnectorContainerMap.entrySet()) {
600 Set<String> ncContainers = entry.getValue();
601 if (ncContainers.contains(containerName)) {
602 NodeConnector nodeConnector = entry.getKey();
603 removeNodeConnectorSet.add(nodeConnector);
606 for (Map.Entry<Node, Set<String>> entry : nodeContainerMap.entrySet()) {
607 Set<String> nodeContainers = entry.getValue();
608 if (nodeContainers.contains(containerName)) {
609 Node node = entry.getKey();
610 removeNodeSet.add(node);
613 for (NodeConnector nodeConnector : removeNodeConnectorSet) {
614 Set<String> ncContainers = nodeConnectorContainerMap.get(nodeConnector);
615 ncContainers.remove(containerName);
616 if (ncContainers.isEmpty()) {
617 nodeConnectorContainerMap.remove(nodeConnector);
620 for (Node node : removeNodeSet) {
621 Set<String> nodeContainers = nodeContainerMap.get(node);
622 nodeContainers.remove(containerName);
623 if (nodeContainers.isEmpty()) {
624 nodeContainerMap.remove(node);