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.switchmanager.internal;
11 import java.io.FileNotFoundException;
12 import java.io.IOException;
13 import java.io.ObjectInputStream;
14 import java.net.InetAddress;
15 import java.net.NetworkInterface;
16 import java.net.SocketException;
17 import java.util.ArrayList;
18 import java.util.Collections;
19 import java.util.Dictionary;
20 import java.util.EnumSet;
21 import java.util.Enumeration;
22 import java.util.HashMap;
23 import java.util.HashSet;
24 import java.util.List;
27 import java.util.concurrent.ConcurrentHashMap;
28 import java.util.concurrent.ConcurrentMap;
29 import java.util.concurrent.CopyOnWriteArrayList;
31 import org.apache.felix.dm.Component;
32 import org.eclipse.osgi.framework.console.CommandInterpreter;
33 import org.eclipse.osgi.framework.console.CommandProvider;
34 import org.opendaylight.controller.clustering.services.CacheConfigException;
35 import org.opendaylight.controller.clustering.services.CacheExistException;
36 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
37 import org.opendaylight.controller.clustering.services.IClusterServices;
38 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
39 import org.opendaylight.controller.sal.core.Bandwidth;
40 import org.opendaylight.controller.sal.core.Config;
41 import org.opendaylight.controller.sal.core.ConstructionException;
42 import org.opendaylight.controller.sal.core.Description;
43 import org.opendaylight.controller.sal.core.ForwardingMode;
44 import org.opendaylight.controller.sal.core.MacAddress;
45 import org.opendaylight.controller.sal.core.Name;
46 import org.opendaylight.controller.sal.core.Node;
47 import org.opendaylight.controller.sal.core.NodeConnector;
48 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
49 import org.opendaylight.controller.sal.core.Property;
50 import org.opendaylight.controller.sal.core.State;
51 import org.opendaylight.controller.sal.core.Tier;
52 import org.opendaylight.controller.sal.core.UpdateType;
53 import org.opendaylight.controller.sal.inventory.IInventoryService;
54 import org.opendaylight.controller.sal.inventory.IListenInventoryUpdates;
55 import org.opendaylight.controller.sal.reader.NodeDescription;
56 import org.opendaylight.controller.sal.utils.GlobalConstants;
57 import org.opendaylight.controller.sal.utils.HexEncode;
58 import org.opendaylight.controller.sal.utils.IObjectReader;
59 import org.opendaylight.controller.sal.utils.ObjectReader;
60 import org.opendaylight.controller.sal.utils.ObjectWriter;
61 import org.opendaylight.controller.sal.utils.Status;
62 import org.opendaylight.controller.sal.utils.StatusCode;
63 import org.opendaylight.controller.statisticsmanager.IStatisticsManager;
64 import org.opendaylight.controller.switchmanager.IInventoryListener;
65 import org.opendaylight.controller.switchmanager.ISpanAware;
66 import org.opendaylight.controller.switchmanager.ISwitchManager;
67 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
68 import org.opendaylight.controller.switchmanager.SpanConfig;
69 import org.opendaylight.controller.switchmanager.Subnet;
70 import org.opendaylight.controller.switchmanager.SubnetConfig;
71 import org.opendaylight.controller.switchmanager.Switch;
72 import org.opendaylight.controller.switchmanager.SwitchConfig;
73 import org.osgi.framework.BundleContext;
74 import org.osgi.framework.FrameworkUtil;
75 import org.slf4j.Logger;
76 import org.slf4j.LoggerFactory;
79 * The class describes SwitchManager which is the central repository of all the
80 * inventory data including nodes, node connectors, properties attached, Layer3
81 * configurations, Span configurations, node configurations, network device
82 * representations viewed by Controller Web applications. One SwitchManager
83 * instance per container of the network. All the node/nodeConnector properties
84 * are maintained in the default container only.
86 public class SwitchManager implements ISwitchManager, IConfigurationContainerAware,
87 IObjectReader, IListenInventoryUpdates, CommandProvider {
88 private static Logger log = LoggerFactory.getLogger(SwitchManager.class);
89 private static String ROOT = GlobalConstants.STARTUPHOME.toString();
90 private String subnetFileName, spanFileName, switchConfigFileName;
91 private final List<NodeConnector> spanNodeConnectors = new CopyOnWriteArrayList<NodeConnector>();
92 // Collection of Subnets keyed by the InetAddress
93 private ConcurrentMap<InetAddress, Subnet> subnets;
94 private ConcurrentMap<String, SubnetConfig> subnetsConfigList;
95 private ConcurrentMap<SpanConfig, SpanConfig> spanConfigList;
96 // manually configured parameters for the node such as name, tier, mode
97 private ConcurrentMap<String, SwitchConfig> nodeConfigList;
98 private ConcurrentMap<Node, Map<String, Property>> nodeProps;
99 private ConcurrentMap<NodeConnector, Map<String, Property>> nodeConnectorProps;
100 private ConcurrentMap<Node, Map<String, NodeConnector>> nodeConnectorNames;
101 private ConcurrentMap<String, Property> controllerProps;
102 private IInventoryService inventoryService;
103 private IStatisticsManager statisticsManager;
104 private final Set<ISwitchManagerAware> switchManagerAware = Collections
105 .synchronizedSet(new HashSet<ISwitchManagerAware>());
106 private final Set<IInventoryListener> inventoryListeners = Collections
107 .synchronizedSet(new HashSet<IInventoryListener>());
108 private final Set<ISpanAware> spanAware = Collections.synchronizedSet(new HashSet<ISpanAware>());
109 private static boolean hostRefresh = true;
110 private int hostRetryCount = 5;
111 private IClusterContainerServices clusterContainerService = null;
112 private String containerName = null;
113 private boolean isDefaultContainer = true;
114 private static final int REPLACE_RETRY = 1;
116 public void notifySubnetChange(Subnet sub, boolean add) {
117 synchronized (switchManagerAware) {
118 for (Object subAware : switchManagerAware) {
120 ((ISwitchManagerAware) subAware).subnetNotify(sub, add);
121 } catch (Exception e) {
122 log.error("Failed to notify Subnet change {}",
129 public void notifySpanPortChange(Node node, List<NodeConnector> ports, boolean add) {
130 synchronized (spanAware) {
131 for (Object sa : spanAware) {
133 ((ISpanAware) sa).spanUpdate(node, ports, add);
134 } catch (Exception e) {
135 log.error("Failed to notify Span Interface change {}",
142 private void notifyModeChange(Node node, boolean proactive) {
143 synchronized (switchManagerAware) {
144 for (ISwitchManagerAware service : switchManagerAware) {
146 service.modeChangeNotify(node, proactive);
147 } catch (Exception e) {
148 log.error("Failed to notify Subnet change {}",
155 public void startUp() {
156 String container = this.getContainerName();
157 // Initialize configuration file names
158 subnetFileName = ROOT + "subnets_" + container + ".conf";
159 spanFileName = ROOT + "spanPorts_" + container + ".conf";
160 switchConfigFileName = ROOT + "switchConfig_" + container + ".conf";
162 // Instantiate cluster synced variables
167 * Read startup and build database if we have not already gotten the
168 * configurations synced from another node
170 if (subnetsConfigList.isEmpty()) {
171 loadSubnetConfiguration();
173 if (spanConfigList.isEmpty()) {
174 loadSpanConfiguration();
176 if (nodeConfigList.isEmpty()) {
177 loadSwitchConfiguration();
180 // Add controller MAC, if first node in the cluster
181 if (!controllerProps.containsKey(MacAddress.name)) {
182 byte controllerMac[] = getHardwareMAC();
183 if (controllerMac != null) {
184 Property existing = controllerProps.putIfAbsent(MacAddress.name, new MacAddress(controllerMac));
185 if (existing == null && log.isTraceEnabled()) {
186 log.trace("Container {}: Setting controller MAC address in the cluster: {}", container,
187 HexEncode.bytesToHexStringFormat(controllerMac));
193 public void shutDown() {
196 @SuppressWarnings("deprecation")
197 private void allocateCaches() {
198 if (this.clusterContainerService == null) {
199 this.nonClusterObjectCreate();
200 log.warn("un-initialized clusterContainerService, can't create cache");
205 clusterContainerService.createCache(
206 "switchmanager.subnetsConfigList",
207 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
208 clusterContainerService.createCache("switchmanager.spanConfigList",
209 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
210 clusterContainerService.createCache("switchmanager.nodeConfigList",
211 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
212 clusterContainerService.createCache("switchmanager.subnets",
213 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
214 clusterContainerService.createCache(
215 "switchmanager.configSaveEvent",
216 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
217 clusterContainerService.createCache("switchmanager.nodeProps",
218 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
219 clusterContainerService.createCache(
220 "switchmanager.nodeConnectorProps",
221 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
222 clusterContainerService.createCache(
223 "switchmanager.nodeConnectorNames",
224 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
225 clusterContainerService.createCache(
226 "switchmanager.controllerProps",
227 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
228 } catch (CacheConfigException cce) {
229 log.error("\nCache configuration invalid - check cache mode");
230 } catch (CacheExistException ce) {
231 log.error("\nCache already exits - destroy and recreate if needed");
235 @SuppressWarnings({ "unchecked", "deprecation" })
236 private void retrieveCaches() {
237 if (this.clusterContainerService == null) {
238 log.info("un-initialized clusterContainerService, can't create cache");
242 subnetsConfigList = (ConcurrentMap<String, SubnetConfig>) clusterContainerService
243 .getCache("switchmanager.subnetsConfigList");
244 if (subnetsConfigList == null) {
245 log.error("\nFailed to get cache for subnetsConfigList");
248 spanConfigList = (ConcurrentMap<SpanConfig, SpanConfig>) clusterContainerService
249 .getCache("switchmanager.spanConfigList");
250 if (spanConfigList == null) {
251 log.error("\nFailed to get cache for spanConfigList");
254 nodeConfigList = (ConcurrentMap<String, SwitchConfig>) clusterContainerService
255 .getCache("switchmanager.nodeConfigList");
256 if (nodeConfigList == null) {
257 log.error("\nFailed to get cache for nodeConfigList");
260 subnets = (ConcurrentMap<InetAddress, Subnet>) clusterContainerService
261 .getCache("switchmanager.subnets");
262 if (subnets == null) {
263 log.error("\nFailed to get cache for subnets");
266 nodeProps = (ConcurrentMap<Node, Map<String, Property>>) clusterContainerService
267 .getCache("switchmanager.nodeProps");
268 if (nodeProps == null) {
269 log.error("\nFailed to get cache for nodeProps");
272 nodeConnectorProps = (ConcurrentMap<NodeConnector, Map<String, Property>>) clusterContainerService
273 .getCache("switchmanager.nodeConnectorProps");
274 if (nodeConnectorProps == null) {
275 log.error("\nFailed to get cache for nodeConnectorProps");
278 nodeConnectorNames = (ConcurrentMap<Node, Map<String, NodeConnector>>) clusterContainerService
279 .getCache("switchmanager.nodeConnectorNames");
280 if (nodeConnectorNames == null) {
281 log.error("\nFailed to get cache for nodeConnectorNames");
284 controllerProps = (ConcurrentMap<String, Property>) clusterContainerService
285 .getCache("switchmanager.controllerProps");
286 if (controllerProps == null) {
287 log.error("\nFailed to get cache for controllerProps");
291 private void nonClusterObjectCreate() {
292 subnetsConfigList = new ConcurrentHashMap<String, SubnetConfig>();
293 spanConfigList = new ConcurrentHashMap<SpanConfig, SpanConfig>();
294 nodeConfigList = new ConcurrentHashMap<String, SwitchConfig>();
295 subnets = new ConcurrentHashMap<InetAddress, Subnet>();
296 nodeProps = new ConcurrentHashMap<Node, Map<String, Property>>();
297 nodeConnectorProps = new ConcurrentHashMap<NodeConnector, Map<String, Property>>();
298 nodeConnectorNames = new ConcurrentHashMap<Node, Map<String, NodeConnector>>();
299 controllerProps = new ConcurrentHashMap<String, Property>();
303 public List<SubnetConfig> getSubnetsConfigList() {
304 return new ArrayList<SubnetConfig>(subnetsConfigList.values());
308 public SubnetConfig getSubnetConfig(String subnet) {
309 return subnetsConfigList.get(subnet);
312 private List<SpanConfig> getSpanConfigList(Node node) {
313 List<SpanConfig> confList = new ArrayList<SpanConfig>();
314 String nodeId = node.toString();
315 for (SpanConfig conf : spanConfigList.values()) {
316 if (conf.matchNode(nodeId)) {
323 public List<SwitchConfig> getNodeConfigList() {
324 return new ArrayList<SwitchConfig>(nodeConfigList.values());
328 public SwitchConfig getSwitchConfig(String switchId) {
329 return nodeConfigList.get(switchId);
332 public Switch getSwitchByNode(Node node) {
333 Switch sw = new Switch(node);
335 MacAddress mac = (MacAddress) this.getNodeProp(node,
338 sw.setDataLayerAddress(mac.getMacAddress());
340 Set<NodeConnector> ncSet = getPhysicalNodeConnectors(node);
341 sw.setNodeConnectors(ncSet);
343 List<NodeConnector> ncList = new ArrayList<NodeConnector>();
344 for (NodeConnector nodeConnector : ncSet) {
345 if (spanNodeConnectors.contains(nodeConnector)) {
346 ncList.add(nodeConnector);
349 sw.addSpanPorts(ncList);
355 public List<Switch> getNetworkDevices() {
356 Set<Node> nodeSet = getNodes();
357 List<Switch> swList = new ArrayList<Switch>();
358 if (nodeSet != null) {
359 for (Node node : nodeSet) {
360 swList.add(getSwitchByNode(node));
367 private Status updateConfig(SubnetConfig conf, boolean add) {
369 if(subnetsConfigList.putIfAbsent(conf.getName(), conf) != null) {
370 String msg = "Cluster conflict: Subnet with name " + conf.getName() + "already exists.";
371 return new Status(StatusCode.CONFLICT, msg);
374 subnetsConfigList.remove(conf.getName());
376 return new Status(StatusCode.SUCCESS);
379 private Status updateDatabase(SubnetConfig conf, boolean add) {
381 Subnet subnetCurr = subnets.get(conf.getIPnum());
383 if (subnetCurr == null) {
384 subnet = new Subnet(conf);
386 subnet = subnetCurr.clone();
388 // In case of API3 call we may receive the ports along with the
390 if (!conf.isGlobal()) {
391 Set<NodeConnector> sp = conf.getSubnetNodeConnectors();
392 subnet.addNodeConnectors(sp);
394 boolean putNewSubnet = false;
395 if(subnetCurr == null) {
396 if(subnets.putIfAbsent(conf.getIPnum(), subnet) == null) {
400 putNewSubnet = subnets.replace(conf.getIPnum(), subnetCurr, subnet);
403 String msg = "Cluster conflict: Conflict while adding the subnet " + conf.getIPnum();
404 return new Status(StatusCode.CONFLICT, msg);
407 // Subnet removal case
409 subnets.remove(conf.getIPnum());
411 return new Status(StatusCode.SUCCESS);
414 private Status semanticCheck(SubnetConfig conf) {
415 Subnet newSubnet = new Subnet(conf);
416 Set<InetAddress> IPs = subnets.keySet();
418 return new Status(StatusCode.SUCCESS);
420 for (InetAddress i : IPs) {
421 Subnet existingSubnet = subnets.get(i);
422 if ((existingSubnet != null)
423 && !existingSubnet.isMutualExclusive(newSubnet)) {
424 return new Status(StatusCode.CONFLICT);
427 return new Status(StatusCode.SUCCESS);
430 private Status addRemoveSubnet(SubnetConfig conf, boolean isAdding) {
431 // Valid config check
432 if (!conf.isValidConfig()) {
433 String msg = "Invalid Subnet configuration";
435 return new Status(StatusCode.BADREQUEST, msg);
440 if (subnetsConfigList.containsKey(conf.getName())) {
441 return new Status(StatusCode.CONFLICT,
442 "Subnet with the specified name already configured.");
445 Status rc = semanticCheck(conf);
446 if (!rc.isSuccess()) {
452 Status rc = updateDatabase(conf, isAdding);
454 if (rc.isSuccess()) {
455 // Update Configuration
456 rc = updateConfig(conf, isAdding);
457 if(!rc.isSuccess()) {
458 updateDatabase(conf, (!isAdding));
466 * Adds Subnet configured in GUI or API3
469 public Status addSubnet(SubnetConfig conf) {
470 return this.addRemoveSubnet(conf, true);
474 public Status removeSubnet(SubnetConfig conf) {
475 return this.addRemoveSubnet(conf, false);
479 public Status removeSubnet(String name) {
480 SubnetConfig conf = subnetsConfigList.get(name);
482 return new Status(StatusCode.SUCCESS, "Subnet not present");
484 return this.addRemoveSubnet(conf, false);
488 public Status addPortsToSubnet(String name, String switchPorts) {
489 SubnetConfig confCurr = subnetsConfigList.get(name);
490 if (confCurr == null) {
491 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
493 if (!confCurr.isValidSwitchPort(switchPorts)) {
494 return new Status(StatusCode.BADREQUEST, "Invalid switchports");
497 Subnet subCurr = subnets.get(confCurr.getIPnum());
498 if (subCurr == null) {
499 log.debug("Cluster conflict: Subnet entry {} is not present in the subnets cache.", confCurr.getIPnum());
500 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
504 Subnet sub = subCurr.clone();
505 Set<NodeConnector> sp = confCurr.getNodeConnectors(switchPorts);
506 sub.addNodeConnectors(sp);
507 boolean subnetsReplaced = subnets.replace(confCurr.getIPnum(), subCurr, sub);
508 if (!subnetsReplaced) {
509 String msg = "Cluster conflict: Conflict while adding ports to the subnet " + name;
510 return new Status(StatusCode.CONFLICT, msg);
513 // Update Configuration
514 SubnetConfig conf = confCurr.clone();
515 conf.addNodeConnectors(switchPorts);
516 boolean configReplaced = subnetsConfigList.replace(name, confCurr, conf);
517 if (!configReplaced) {
518 // TODO: recovery using Transactionality
519 String msg = "Cluster conflict: Conflict while adding ports to the subnet " + name;
520 return new Status(StatusCode.CONFLICT, msg);
523 return new Status(StatusCode.SUCCESS);
527 public Status removePortsFromSubnet(String name, String switchPorts) {
528 SubnetConfig confCurr = subnetsConfigList.get(name);
529 if (confCurr == null) {
530 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
533 Subnet subCurr = subnets.get(confCurr.getIPnum());
534 if (subCurr == null) {
535 log.debug("Cluster conflict: Subnet entry {} is not present in the subnets cache.", confCurr.getIPnum());
536 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
540 Subnet sub = subCurr.clone();
541 Set<NodeConnector> sp = confCurr.getNodeConnectors(switchPorts);
542 sub.deleteNodeConnectors(sp);
543 boolean subnetsReplace = subnets.replace(confCurr.getIPnum(), subCurr, sub);
544 if (!subnetsReplace) {
545 String msg = "Cluster conflict: Conflict while removing ports from the subnet " + name;
546 return new Status(StatusCode.CONFLICT, msg);
549 // Update Configuration
550 SubnetConfig conf = confCurr.clone();
551 conf.removeNodeConnectors(switchPorts);
552 boolean result = subnetsConfigList.replace(name, confCurr, conf);
554 // TODO: recovery using Transactionality
555 String msg = "Cluster conflict: Conflict while removing ports from " + conf;
556 return new Status(StatusCode.CONFLICT, msg);
559 return new Status(StatusCode.SUCCESS);
562 public String getContainerName() {
563 if (containerName == null) {
564 return GlobalConstants.DEFAULT.toString();
566 return containerName;
570 public Subnet getSubnetByNetworkAddress(InetAddress networkAddress) {
572 Set<InetAddress> indices = subnets.keySet();
573 for (InetAddress i : indices) {
574 sub = subnets.get(i);
575 if (sub.isSubnetOf(networkAddress)) {
583 public Object readObject(ObjectInputStream ois)
584 throws FileNotFoundException, IOException, ClassNotFoundException {
585 // Perform the class deserialization locally, from inside the package
586 // where the class is defined
587 return ois.readObject();
590 @SuppressWarnings("unchecked")
591 private void loadSubnetConfiguration() {
592 ObjectReader objReader = new ObjectReader();
593 ConcurrentMap<String, SubnetConfig> confList = (ConcurrentMap<String, SubnetConfig>) objReader
594 .read(this, subnetFileName);
596 if (confList == null) {
600 for (SubnetConfig conf : confList.values()) {
605 @SuppressWarnings("unchecked")
606 private void loadSpanConfiguration() {
607 ObjectReader objReader = new ObjectReader();
608 ConcurrentMap<Integer, SpanConfig> confList = (ConcurrentMap<Integer, SpanConfig>) objReader
609 .read(this, spanFileName);
611 if (confList == null) {
615 for (SpanConfig conf : confList.values()) {
620 @SuppressWarnings("unchecked")
621 private void loadSwitchConfiguration() {
622 ObjectReader objReader = new ObjectReader();
623 ConcurrentMap<String, SwitchConfig> confList = (ConcurrentMap<String, SwitchConfig>) objReader
624 .read(this, switchConfigFileName);
626 if (confList == null) {
630 for (SwitchConfig conf : confList.values()) {
631 updateNodeConfig(conf);
636 public void updateSwitchConfig(SwitchConfig cfgObject) {
637 // update default container only
638 if (!isDefaultContainer) {
642 SwitchConfig sc = nodeConfigList.get(cfgObject.getNodeId());
644 if (nodeConfigList.putIfAbsent(cfgObject.getNodeId(), cfgObject) != null) {
648 if (!nodeConfigList.replace(cfgObject.getNodeId(), sc, cfgObject)) {
653 boolean modeChange = false;
655 if ((sc == null) || !cfgObject.getMode().equals(sc.getMode())) {
659 String nodeId = cfgObject.getNodeId();
660 Node node = Node.fromString(nodeId);
661 Map<String, Property> propMapCurr = nodeProps.get(node);
662 if (propMapCurr == null) {
665 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
666 Property desc = new Description(cfgObject.getNodeDescription());
667 propMap.put(desc.getName(), desc);
668 Property tier = new Tier(Integer.parseInt(cfgObject.getTier()));
669 propMap.put(tier.getName(), tier);
671 if (!nodeProps.replace(node, propMapCurr, propMap)) {
672 // TODO rollback using Transactionality
676 log.info("Set Node {}'s Mode to {}", nodeId, cfgObject.getMode());
679 notifyModeChange(node, cfgObject.isProactive());
684 public Status updateNodeConfig(SwitchConfig switchConfig) {
685 Status status = switchConfig.validate();
686 if (!status.isSuccess()) {
690 Map<String, Property> updateProperties = switchConfig.getNodeProperties();
691 ForwardingMode mode = (ForwardingMode) updateProperties.get(ForwardingMode.name);
693 if (isDefaultContainer) {
694 if (!mode.isValid()) {
695 return new Status(StatusCode.BADREQUEST, "Invalid Forwarding Mode Value");
698 return new Status(StatusCode.NOTACCEPTABLE,
699 "Forwarding Mode modification is allowed only in default container");
703 Description description = (Description) switchConfig.getProperty(Description.propertyName);
704 String nodeId = switchConfig.getNodeId();
705 Node node = Node.fromString(nodeId);
706 NodeDescription nodeDesc = (this.statisticsManager == null) ? null : this.statisticsManager
707 .getNodeDescription(node);
708 String advertisedDesc = (nodeDesc == null) ? "" : nodeDesc.getDescription();
709 if (description != null && description.getValue() != null) {
710 if (description.getValue().isEmpty() || description.getValue().equals(advertisedDesc)) {
711 updateProperties.remove(Description.propertyName);
712 switchConfig = new SwitchConfig(nodeId, updateProperties);
714 // check if description is configured or was published by any other node
715 for (Map.Entry<Node, Map<String, Property>> entry : nodeProps.entrySet()) {
716 Node n = entry.getKey();
717 Description desc = (Description) getNodeProp(n, Description.propertyName);
718 NodeDescription nDesc = (this.statisticsManager == null) ? null : this.statisticsManager
719 .getNodeDescription(n);
720 String advDesc = (nDesc == null) ? "" : nDesc.getDescription();
721 if ((description.equals(desc) || description.getValue().equals(advDesc)) && !node.equals(n)) {
722 return new Status(StatusCode.CONFLICT, "Node name already in use");
728 boolean modeChange = false;
729 SwitchConfig sc = nodeConfigList.get(nodeId);
730 Map<String, Property> prevNodeProperties = new HashMap<String, Property>();
732 if ((mode != null) && mode.isProactive()) {
735 if (!updateProperties.isEmpty()) {
736 if (nodeConfigList.putIfAbsent(nodeId, switchConfig) != null) {
737 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
741 prevNodeProperties = new HashMap<String, Property>(sc.getNodeProperties());
742 ForwardingMode prevMode = (ForwardingMode) sc.getProperty(ForwardingMode.name);
744 if ((prevMode != null) && (prevMode.isProactive())) {
748 if (((prevMode != null) && (prevMode.getValue() != mode.getValue()))
749 || (prevMode == null && mode.isProactive())) {
753 if (updateProperties.isEmpty()) {
754 nodeConfigList.remove(nodeId);
756 if (!nodeConfigList.replace(nodeId, sc, switchConfig)) {
757 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
761 Map<String, Property> propMapCurr = nodeProps.get(node);
762 if (propMapCurr == null) {
763 return new Status(StatusCode.SUCCESS);
765 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
766 for (Map.Entry<String, Property> entry : prevNodeProperties.entrySet()) {
767 String prop = entry.getKey();
768 if (!updateProperties.containsKey(prop)) {
769 if (prop.equals(Description.propertyName)) {
770 if (!advertisedDesc.isEmpty()) {
771 Property desc = new Description(advertisedDesc);
772 propMap.put(Description.propertyName, desc);
776 propMap.remove(prop);
779 propMap.putAll(updateProperties);
780 if (!nodeProps.replace(node, propMapCurr, propMap)) {
781 // TODO rollback using Transactionality
782 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
785 notifyModeChange(node, (mode == null) ? false : mode.isProactive());
787 return new Status(StatusCode.SUCCESS);
791 public Status removeNodeConfig(String nodeId) {
792 if ((nodeId == null) || (nodeId.isEmpty())) {
793 return new Status(StatusCode.BADREQUEST, "nodeId cannot be empty.");
795 Map<String, Property> nodeProperties = getSwitchConfig(nodeId).getNodeProperties();
796 Node node = Node.fromString(nodeId);
797 Map<String, Property> propMapCurr = nodeProps.get(node);
798 if ((propMapCurr != null) && (nodeProperties != null) && (!nodeProperties.isEmpty())) {
799 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
800 for (Map.Entry<String, Property> entry : nodeProperties.entrySet()) {
801 String prop = entry.getKey();
802 if (prop.equals(Description.propertyName)) {
803 Map<Node, Map<String, Property>> nodeProp = this.inventoryService.getNodeProps();
804 if (nodeProp.get(node) != null) {
805 propMap.put(Description.propertyName, nodeProp.get(node).get(Description.propertyName));
809 propMap.remove(prop);
811 if (!nodeProps.replace(node, propMapCurr, propMap)) {
812 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration.");
815 if (nodeConfigList != null) {
816 nodeConfigList.remove(nodeId);
818 return new Status(StatusCode.SUCCESS);
822 public Status saveSwitchConfig() {
823 return saveSwitchConfigInternal();
826 public Status saveSwitchConfigInternal() {
827 Status retS = null, retP = null;
828 ObjectWriter objWriter = new ObjectWriter();
830 retS = objWriter.write(new ConcurrentHashMap<String, SubnetConfig>(
831 subnetsConfigList), subnetFileName);
832 retP = objWriter.write(new ConcurrentHashMap<SpanConfig, SpanConfig>(
833 spanConfigList), spanFileName);
834 retS = objWriter.write(new ConcurrentHashMap<String, SwitchConfig>(
835 nodeConfigList), switchConfigFileName);
836 if (retS.equals(retP)) {
837 if (retS.isSuccess()) {
840 return new Status(StatusCode.INTERNALERROR, "Save failed");
843 return new Status(StatusCode.INTERNALERROR, "Partial save failure");
848 public List<SpanConfig> getSpanConfigList() {
849 return new ArrayList<SpanConfig>(spanConfigList.values());
853 public Status addSpanConfig(SpanConfig conf) {
854 // Valid config check
855 if (!conf.isValidConfig()) {
856 String msg = "Invalid Span configuration";
858 return new Status(StatusCode.BADREQUEST, msg);
862 if (spanConfigList.containsKey(conf)) {
863 return new Status(StatusCode.CONFLICT, "Same span config exists");
866 // Update configuration
867 if (spanConfigList.putIfAbsent(conf, conf) == null) {
868 // Update database and notify clients
869 addSpanPorts(conf.getNode(), conf.getPortArrayList());
872 return new Status(StatusCode.SUCCESS);
876 public Status removeSpanConfig(SpanConfig conf) {
877 removeSpanPorts(conf.getNode(), conf.getPortArrayList());
879 // Update configuration
880 spanConfigList.remove(conf);
882 return new Status(StatusCode.SUCCESS);
886 public List<NodeConnector> getSpanPorts(Node node) {
887 List<NodeConnector> ncList = new ArrayList<NodeConnector>();
889 for (NodeConnector nodeConnector : spanNodeConnectors) {
890 if (nodeConnector.getNode().equals(node)) {
891 ncList.add(nodeConnector);
897 private void addNode(Node node, Set<Property> props) {
898 log.trace("{} added, props: {}", node, props);
899 if (nodeProps == null) {
903 Map<String, Property> propMapCurr = nodeProps.get(node);
904 Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
905 : new HashMap<String, Property>(propMapCurr);
907 // copy node properties from plugin
909 for (Property prop : props) {
910 propMap.put(prop.getName(), prop);
914 // copy node properties from config
915 boolean proactiveForwarding = false;
916 if (nodeConfigList != null) {
917 String nodeId = node.toString();
918 SwitchConfig conf = nodeConfigList.get(nodeId);
919 if (conf != null && (conf.getNodeProperties() != null)) {
920 Map<String, Property> nodeProperties = conf.getNodeProperties();
921 propMap.putAll(nodeProperties);
922 if (nodeProperties.get(ForwardingMode.name) != null) {
923 ForwardingMode mode = (ForwardingMode) nodeProperties.get(ForwardingMode.name);
924 proactiveForwarding = mode.isProactive();
929 boolean result = false;
930 if (propMapCurr == null) {
931 if (nodeProps.putIfAbsent(node, propMap) == null) {
935 result = nodeProps.replace(node, propMapCurr, propMap);
938 log.debug("Cluster conflict: Conflict while adding the node properties. Node: {} Properties: {}",
939 node.getID(), props);
940 addNodeProps(node, propMap);
943 // check if span ports are configed
946 // notify node listeners
947 notifyNode(node, UpdateType.ADDED, propMap);
949 // notify proactive mode forwarding
950 if (proactiveForwarding) {
951 notifyModeChange(node, true);
955 private void removeNode(Node node) {
956 log.trace("{} removed", node);
957 if (nodeProps == null) {
960 nodeProps.remove(node);
961 nodeConnectorNames.remove(node);
962 Set<NodeConnector> removeNodeConnectorSet = new HashSet<NodeConnector>();
963 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
964 NodeConnector nodeConnector = entry.getKey();
965 if (nodeConnector.getNode().equals(node)) {
966 removeNodeConnectorSet.add(nodeConnector);
969 for (NodeConnector nc : removeNodeConnectorSet) {
970 nodeConnectorProps.remove(nc);
973 // check if span ports need to be cleaned up
974 removeSpanPorts(node);
976 /* notify node listeners */
977 notifyNode(node, UpdateType.REMOVED, null);
980 private void updateNode(Node node, Set<Property> props) {
981 log.trace("{} updated, props: {}", node, props);
982 if (nodeProps == null || !nodeProps.containsKey(node) ||
983 props == null || props.isEmpty()) {
987 Map<String, Property> propMapCurr = nodeProps.get(node);
988 Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
989 : new HashMap<String, Property>(propMapCurr);
991 // copy node properties from plugin
992 String nodeId = node.toString();
993 for (Property prop : props) {
994 if (nodeConfigList != null) {
995 SwitchConfig conf = nodeConfigList.get(nodeId);
996 if (conf != null && (conf.getNodeProperties() != null)
997 && conf.getNodeProperties().containsKey(prop.getName())) {
1001 propMap.put(prop.getName(), prop);
1004 if (propMapCurr == null) {
1005 if (nodeProps.putIfAbsent(node, propMap) != null) {
1006 log.debug("Cluster conflict: Conflict while updating the node. Node: {} Properties: {}",
1007 node.getID(), props);
1008 addNodeProps(node, propMap);
1011 if (!nodeProps.replace(node, propMapCurr, propMap)) {
1012 log.debug("Cluster conflict: Conflict while updating the node. Node: {} Properties: {}",
1013 node.getID(), props);
1014 addNodeProps(node, propMap);
1018 /* notify node listeners */
1019 notifyNode(node, UpdateType.CHANGED, propMap);
1023 public void updateNode(Node node, UpdateType type, Set<Property> props) {
1024 log.debug("updateNode: {} type {} props {} for container {}",
1025 new Object[] { node, type, props, containerName });
1028 addNode(node, props);
1031 updateNode(node, props);
1042 public void updateNodeConnector(NodeConnector nodeConnector,
1043 UpdateType type, Set<Property> props) {
1044 Map<String, Property> propMap = new HashMap<String, Property>();
1046 log.debug("updateNodeConnector: {} type {} props {} for container {}",
1047 new Object[] { nodeConnector, type, props, containerName });
1049 if (nodeConnectorProps == null) {
1056 if (props != null) {
1057 for (Property prop : props) {
1058 addNodeConnectorProp(nodeConnector, prop);
1059 propMap.put(prop.getName(), prop);
1062 addNodeConnectorProp(nodeConnector, null);
1065 addSpanPort(nodeConnector);
1068 removeNodeConnectorAllProps(nodeConnector);
1070 // clean up span config
1071 removeSpanPort(nodeConnector);
1077 notifyNodeConnector(nodeConnector, type, propMap);
1081 public Set<Node> getNodes() {
1082 return (nodeProps != null) ? new HashSet<Node>(nodeProps.keySet())
1087 * Returns a copy of a list of properties for a given node
1092 * org.opendaylight.controller.switchmanager.ISwitchManager#getNodeProps
1093 * (org.opendaylight.controller.sal.core.Node)
1096 public Map<String, Property> getNodeProps(Node node) {
1097 Map<String, Property> rv = new HashMap<String, Property>();
1098 if (this.nodeProps != null) {
1099 rv = this.nodeProps.get(node);
1101 /* make a copy of it */
1102 rv = new HashMap<String, Property>(rv);
1109 public Property getNodeProp(Node node, String propName) {
1110 Map<String, Property> propMap = getNodeProps(node);
1111 return (propMap != null) ? propMap.get(propName) : null;
1115 public void setNodeProp(Node node, Property prop) {
1117 for (int i = 0; i <= REPLACE_RETRY; i++) {
1118 /* Get a copy of the property map */
1119 Map<String, Property> propMapCurr = getNodeProps(node);
1120 if (propMapCurr == null) {
1124 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1125 propMap.put(prop.getName(), prop);
1127 if (nodeProps.replace(node, propMapCurr, propMap)) {
1130 if (!propMapCurr.get(prop.getName()).equals(nodeProps.get(node).get(prop.getName()))) {
1131 log.debug("Cluster conflict: Unable to add property {} to node {}.", prop.getName(), node.getID());
1135 log.warn("Cluster conflict: Unable to add property {} to node {}.", prop.getName(), node.getID());
1139 public Status removeNodeProp(Node node, String propName) {
1140 for (int i = 0; i <= REPLACE_RETRY; i++) {
1141 Map<String, Property> propMapCurr = getNodeProps(node);
1142 if (propMapCurr != null) {
1143 if (!propMapCurr.containsKey(propName)) {
1144 return new Status(StatusCode.SUCCESS);
1146 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1147 propMap.remove(propName);
1148 if (nodeProps.replace(node, propMapCurr, propMap)) {
1149 return new Status(StatusCode.SUCCESS);
1151 if (!propMapCurr.get(propName).equals(nodeProps.get(node).get(propName))) {
1152 String msg = "Cluster conflict: Unable to remove property " + propName + " for node "
1154 return new Status(StatusCode.CONFLICT, msg);
1158 return new Status(StatusCode.SUCCESS);
1161 String msg = "Cluster conflict: Unable to remove property " + propName + " for node " + node.getID();
1162 return new Status(StatusCode.CONFLICT, msg);
1166 public Status removeNodeAllProps(Node node) {
1167 this.nodeProps.remove(node);
1168 return new Status(StatusCode.SUCCESS);
1172 public Set<NodeConnector> getUpNodeConnectors(Node node) {
1173 if (nodeConnectorProps == null) {
1177 Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1178 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1179 NodeConnector nodeConnector = entry.getKey();
1180 if (!nodeConnector.getNode().equals(node)) {
1183 if (isNodeConnectorEnabled(nodeConnector)) {
1184 nodeConnectorSet.add(nodeConnector);
1188 return nodeConnectorSet;
1192 public Set<NodeConnector> getNodeConnectors(Node node) {
1193 if (nodeConnectorProps == null) {
1197 Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1198 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1199 NodeConnector nodeConnector = entry.getKey();
1200 if (!nodeConnector.getNode().equals(node)) {
1203 nodeConnectorSet.add(nodeConnector);
1206 return nodeConnectorSet;
1210 public Set<NodeConnector> getPhysicalNodeConnectors(Node node) {
1211 if (nodeConnectorProps == null) {
1215 Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1216 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1217 NodeConnector nodeConnector = entry.getKey();
1218 if (!nodeConnector.getNode().equals(node)
1219 || isSpecial(nodeConnector)) {
1222 nodeConnectorSet.add(nodeConnector);
1225 return nodeConnectorSet;
1229 public Map<String, Property> getNodeConnectorProps(NodeConnector nodeConnector) {
1230 Map<String, Property> rv = new HashMap<String, Property>();
1231 if (this.nodeConnectorProps != null) {
1232 rv = this.nodeConnectorProps.get(nodeConnector);
1234 rv = new HashMap<String, Property>(rv);
1241 public Property getNodeConnectorProp(NodeConnector nodeConnector,
1243 Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1244 return (propMap != null) ? propMap.get(propName) : null;
1247 private byte[] getHardwareMAC() {
1248 Enumeration<NetworkInterface> nis;
1249 byte[] macAddress = null;
1252 nis = NetworkInterface.getNetworkInterfaces();
1253 } catch (SocketException e) {
1254 log.error("Failed to acquire controller MAC: ", e);
1258 while (nis.hasMoreElements()) {
1259 NetworkInterface ni = nis.nextElement();
1261 macAddress = ni.getHardwareAddress();
1262 } catch (SocketException e) {
1263 log.error("Failed to acquire controller MAC: ", e);
1265 if (macAddress != null) {
1269 if (macAddress == null) {
1270 log.warn("Failed to acquire controller MAC: No physical interface found");
1271 // This happens when running controller on windows VM, for example
1272 // Try parsing the OS command output
1278 public byte[] getControllerMAC() {
1279 MacAddress macProperty = (MacAddress)controllerProps.get(MacAddress.name);
1280 return (macProperty == null) ? null : macProperty.getMacAddress();
1284 public boolean isHostRefreshEnabled() {
1289 public int getHostRetryCount() {
1290 return hostRetryCount;
1294 public NodeConnector getNodeConnector(Node node, String nodeConnectorName) {
1295 if (nodeConnectorNames == null) {
1299 Map<String, NodeConnector> map = nodeConnectorNames.get(node);
1304 return map.get(nodeConnectorName);
1308 * Adds a node connector and its property if any
1310 * @param nodeConnector
1311 * {@link org.opendaylight.controller.sal.core.NodeConnector}
1313 * name of {@link org.opendaylight.controller.sal.core.Property}
1314 * @return success or failed reason
1317 public Status addNodeConnectorProp(NodeConnector nodeConnector,
1319 Map<String, Property> propMapCurr = getNodeConnectorProps(nodeConnector);
1320 Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
1321 : new HashMap<String, Property>(propMapCurr);
1323 String msg = "Cluster conflict: Unable to add NodeConnector Property.";
1324 // Just add the nodeConnector if prop is not available (in a non-default
1327 if (propMapCurr == null) {
1328 if (nodeConnectorProps.putIfAbsent(nodeConnector, propMap) != null) {
1329 return new Status(StatusCode.CONFLICT, msg);
1332 if (!nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap)) {
1333 return new Status(StatusCode.CONFLICT, msg);
1336 return new Status(StatusCode.SUCCESS);
1339 propMap.put(prop.getName(), prop);
1340 if (propMapCurr == null) {
1341 if (nodeConnectorProps.putIfAbsent(nodeConnector, propMap) != null) {
1342 return new Status(StatusCode.CONFLICT, msg);
1345 if (!nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap)) {
1346 return new Status(StatusCode.CONFLICT, msg);
1350 if (prop.getName().equals(Name.NamePropName)) {
1351 if (nodeConnectorNames != null) {
1352 Node node = nodeConnector.getNode();
1353 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1354 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1355 if (mapCurr != null) {
1356 for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1357 String s = entry.getKey();
1359 map.put(s, new NodeConnector(entry.getValue()));
1360 } catch (ConstructionException e) {
1361 e.printStackTrace();
1366 map.put(((Name) prop).getValue(), nodeConnector);
1367 if (mapCurr == null) {
1368 if (nodeConnectorNames.putIfAbsent(node, map) != null) {
1369 // TODO: recovery using Transactionality
1370 return new Status(StatusCode.CONFLICT, msg);
1373 if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1374 // TODO: recovery using Transactionality
1375 return new Status(StatusCode.CONFLICT, msg);
1381 return new Status(StatusCode.SUCCESS);
1385 * Removes one property of a node connector
1387 * @param nodeConnector
1388 * {@link org.opendaylight.controller.sal.core.NodeConnector}
1390 * name of {@link org.opendaylight.controller.sal.core.Property}
1391 * @return success or failed reason
1394 public Status removeNodeConnectorProp(NodeConnector nodeConnector, String propName) {
1395 Map<String, Property> propMapCurr = getNodeConnectorProps(nodeConnector);
1397 if (propMapCurr == null) {
1398 /* Nothing to remove */
1399 return new Status(StatusCode.SUCCESS);
1402 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1403 propMap.remove(propName);
1404 boolean result = nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap);
1405 String msg = "Cluster conflict: Unable to remove NodeConnector property.";
1407 return new Status(StatusCode.CONFLICT, msg);
1410 if (propName.equals(Name.NamePropName)) {
1411 if (nodeConnectorNames != null) {
1412 Name name = ((Name) getNodeConnectorProp(nodeConnector, Name.NamePropName));
1414 Node node = nodeConnector.getNode();
1415 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1416 if (mapCurr != null) {
1417 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1418 for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1419 String s = entry.getKey();
1421 map.put(s, new NodeConnector(entry.getValue()));
1422 } catch (ConstructionException e) {
1423 e.printStackTrace();
1426 map.remove(name.getValue());
1427 if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1428 // TODO: recovery using Transactionality
1429 return new Status(StatusCode.CONFLICT, msg);
1436 return new Status(StatusCode.SUCCESS);
1440 * Removes all the properties of a node connector
1442 * @param nodeConnector
1443 * {@link org.opendaylight.controller.sal.core.NodeConnector}
1444 * @return success or failed reason
1447 public Status removeNodeConnectorAllProps(NodeConnector nodeConnector) {
1448 if (nodeConnectorNames != null) {
1449 Name name = ((Name) getNodeConnectorProp(nodeConnector, Name.NamePropName));
1451 Node node = nodeConnector.getNode();
1452 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1453 if (mapCurr != null) {
1454 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1455 for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1456 String s = entry.getKey();
1458 map.put(s, new NodeConnector(entry.getValue()));
1459 } catch (ConstructionException e) {
1460 e.printStackTrace();
1463 map.remove(name.getValue());
1464 if (map.isEmpty()) {
1465 nodeConnectorNames.remove(node);
1467 if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1468 log.warn("Cluster conflict: Unable remove Name property of nodeconnector {}, skip.",
1469 nodeConnector.getID());
1476 nodeConnectorProps.remove(nodeConnector);
1478 return new Status(StatusCode.SUCCESS);
1482 * Function called by the dependency manager when all the required
1483 * dependencies are satisfied
1486 void init(Component c) {
1487 Dictionary<?, ?> props = c.getServiceProperties();
1488 if (props != null) {
1489 this.containerName = (String) props.get("containerName");
1490 log.trace("Running containerName: {}", this.containerName);
1492 // In the Global instance case the containerName is empty
1493 this.containerName = "";
1495 isDefaultContainer = containerName.equals(GlobalConstants.DEFAULT
1502 * Function called by the dependency manager when at least one dependency
1503 * become unsatisfied or when the component is shutting down because for
1504 * example bundle is being stopped.
1512 * Function called by dependency manager after "init ()" is called and after
1513 * the services provided by the class are registered in the service registry
1518 registerWithOSGIConsole();
1522 * Function called after registered the service in OSGi service registry.
1525 // solicit for existing inventories
1530 * Function called by the dependency manager before the services exported by
1531 * the component are unregistered, this will be followed by a "destroy ()"
1538 public void setInventoryService(IInventoryService service) {
1539 log.trace("Got inventory service set request {}", service);
1540 this.inventoryService = service;
1542 // solicit for existing inventories
1546 public void unsetInventoryService(IInventoryService service) {
1547 log.trace("Got a service UNset request");
1548 this.inventoryService = null;
1550 // clear existing inventories
1554 public void setStatisticsManager(IStatisticsManager statisticsManager) {
1555 log.trace("Got statistics manager set request {}", statisticsManager);
1556 this.statisticsManager = statisticsManager;
1559 public void unsetStatisticsManager(IStatisticsManager statisticsManager) {
1560 log.trace("Got statistics manager UNset request");
1561 this.statisticsManager = null;
1564 public void setSwitchManagerAware(ISwitchManagerAware service) {
1565 log.trace("Got inventory service set request {}", service);
1566 if (this.switchManagerAware != null) {
1567 this.switchManagerAware.add(service);
1570 // bulk update for newly joined
1571 switchManagerAwareNotify(service);
1574 public void unsetSwitchManagerAware(ISwitchManagerAware service) {
1575 log.trace("Got a service UNset request");
1576 if (this.switchManagerAware != null) {
1577 this.switchManagerAware.remove(service);
1581 public void setInventoryListener(IInventoryListener service) {
1582 log.trace("Got inventory listener set request {}", service);
1583 if (this.inventoryListeners != null) {
1584 this.inventoryListeners.add(service);
1587 // bulk update for newly joined
1588 bulkUpdateService(service);
1591 public void unsetInventoryListener(IInventoryListener service) {
1592 log.trace("Got a service UNset request");
1593 if (this.inventoryListeners != null) {
1594 this.inventoryListeners.remove(service);
1598 public void setSpanAware(ISpanAware service) {
1599 log.trace("Got SpanAware set request {}", service);
1600 if (this.spanAware != null) {
1601 this.spanAware.add(service);
1604 // bulk update for newly joined
1605 spanAwareNotify(service);
1608 public void unsetSpanAware(ISpanAware service) {
1609 log.trace("Got a service UNset request");
1610 if (this.spanAware != null) {
1611 this.spanAware.remove(service);
1615 void setClusterContainerService(IClusterContainerServices s) {
1616 log.trace("Cluster Service set");
1617 this.clusterContainerService = s;
1620 void unsetClusterContainerService(IClusterContainerServices s) {
1621 if (this.clusterContainerService == s) {
1622 log.trace("Cluster Service removed!");
1623 this.clusterContainerService = null;
1627 private void getInventories() {
1628 if (inventoryService == null) {
1629 log.trace("inventory service not avaiable");
1633 Map<Node, Map<String, Property>> nodeProp = this.inventoryService.getNodeProps();
1634 for (Map.Entry<Node, Map<String, Property>> entry : nodeProp.entrySet()) {
1635 Node node = entry.getKey();
1636 log.debug("getInventories: {} added for container {}", new Object[] { node, containerName });
1637 Map<String, Property> propMap = entry.getValue();
1638 Set<Property> props = new HashSet<Property>();
1639 for (Property property : propMap.values()) {
1640 props.add(property);
1642 addNode(node, props);
1645 Map<NodeConnector, Map<String, Property>> nodeConnectorProp = this.inventoryService.getNodeConnectorProps();
1646 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProp.entrySet()) {
1647 Map<String, Property> propMap = entry.getValue();
1648 for (Property property : propMap.values()) {
1649 addNodeConnectorProp(entry.getKey(), property);
1654 private void clearInventories() {
1656 nodeConnectorProps.clear();
1657 nodeConnectorNames.clear();
1658 spanNodeConnectors.clear();
1661 private void notifyNode(Node node, UpdateType type,
1662 Map<String, Property> propMap) {
1663 synchronized (inventoryListeners) {
1664 for (IInventoryListener service : inventoryListeners) {
1665 service.notifyNode(node, type, propMap);
1670 private void notifyNodeConnector(NodeConnector nodeConnector,
1671 UpdateType type, Map<String, Property> propMap) {
1672 synchronized (inventoryListeners) {
1673 for (IInventoryListener service : inventoryListeners) {
1674 service.notifyNodeConnector(nodeConnector, type, propMap);
1680 * For those joined late, bring them up-to-date.
1682 private void switchManagerAwareNotify(ISwitchManagerAware service) {
1683 for (Subnet sub : subnets.values()) {
1684 service.subnetNotify(sub, true);
1687 for (Node node : getNodes()) {
1688 SwitchConfig sc = getSwitchConfig(node.toString());
1689 if ((sc != null) && isDefaultContainer) {
1690 ForwardingMode mode = (ForwardingMode) sc.getProperty(ForwardingMode.name);
1691 service.modeChangeNotify(node, (mode == null) ? false : mode.isProactive());
1696 private void bulkUpdateService(IInventoryListener service) {
1697 Map<String, Property> propMap;
1698 UpdateType type = UpdateType.ADDED;
1700 for (Node node : getNodes()) {
1701 propMap = nodeProps.get(node);
1702 service.notifyNode(node, type, propMap);
1705 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1706 NodeConnector nodeConnector = entry.getKey();
1707 propMap = nodeConnectorProps.get(nodeConnector);
1708 service.notifyNodeConnector(nodeConnector, type, propMap);
1712 private void spanAwareNotify(ISpanAware service) {
1713 for (Node node : getNodes()) {
1714 for (SpanConfig conf : getSpanConfigList(node)) {
1715 service.spanUpdate(node, conf.getPortArrayList(), true);
1720 private void registerWithOSGIConsole() {
1721 BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass())
1722 .getBundleContext();
1723 bundleContext.registerService(CommandProvider.class.getName(), this,
1728 public Boolean isNodeConnectorEnabled(NodeConnector nodeConnector) {
1729 if (nodeConnector == null) {
1733 Config config = (Config) getNodeConnectorProp(nodeConnector,
1734 Config.ConfigPropName);
1735 State state = (State) getNodeConnectorProp(nodeConnector,
1736 State.StatePropName);
1737 return ((config != null) && (config.getValue() == Config.ADMIN_UP)
1738 && (state != null) && (state.getValue() == State.EDGE_UP));
1742 public String getHelp() {
1743 StringBuffer help = new StringBuffer();
1744 help.append("---Switch Manager---\n");
1745 help.append("\t pns - Print connected nodes\n");
1746 help.append("\t pncs <node id> - Print node connectors for a given node\n");
1747 help.append("\t pencs <node id> - Print enabled node connectors for a given node\n");
1748 help.append("\t pdm <node id> - Print switch ports in device map\n");
1749 help.append("\t snt <node id> <tier> - Set node tier number\n");
1750 help.append("\t hostRefresh <on/off/?> - Enable/Disable/Query host refresh\n");
1751 help.append("\t hostRetry <count> - Set host retry count\n");
1752 return help.toString();
1755 public void _pns(CommandInterpreter ci) {
1756 ci.println(" Node Type MAC Name Tier");
1757 if (nodeProps == null) {
1760 Set<Node> nodeSet = nodeProps.keySet();
1761 if (nodeSet == null) {
1764 List<String> nodeArray = new ArrayList<String>();
1765 for (Node node : nodeSet) {
1766 nodeArray.add(node.toString());
1768 Collections.sort(nodeArray);
1769 for (String str: nodeArray) {
1770 Node node = Node.fromString(str);
1771 Description desc = ((Description) getNodeProp(node,
1772 Description.propertyName));
1773 Tier tier = ((Tier) getNodeProp(node, Tier.TierPropName));
1774 String nodeName = (desc == null) ? "" : desc.getValue();
1775 MacAddress mac = (MacAddress) getNodeProp(node,
1777 String macAddr = (mac == null) ? "" : HexEncode
1778 .bytesToHexStringFormat(mac.getMacAddress());
1779 int tierNum = (tier == null) ? 0 : tier.getValue();
1780 ci.println(node + " " + node.getType() + " " + macAddr
1781 + " " + nodeName + " " + tierNum);
1783 ci.println("Total number of Nodes: " + nodeSet.size());
1786 public void _pencs(CommandInterpreter ci) {
1787 String st = ci.nextArgument();
1789 ci.println("Please enter node id");
1793 Node node = Node.fromString(st);
1795 ci.println("Please enter node id");
1799 Set<NodeConnector> nodeConnectorSet = getUpNodeConnectors(node);
1800 if (nodeConnectorSet == null) {
1803 for (NodeConnector nodeConnector : nodeConnectorSet) {
1804 if (nodeConnector == null) {
1807 ci.println(nodeConnector);
1809 ci.println("Total number of NodeConnectors: " + nodeConnectorSet.size());
1812 public void _pncs(CommandInterpreter ci) {
1813 String st = ci.nextArgument();
1815 ci.println("Please enter node id");
1819 Node node = Node.fromString(st);
1821 ci.println("Please enter node id");
1825 ci.println(" NodeConnector BandWidth(Gbps) Admin State");
1826 Set<NodeConnector> nodeConnectorSet = getNodeConnectors(node);
1827 if (nodeConnectorSet == null) {
1830 for (NodeConnector nodeConnector : nodeConnectorSet) {
1831 if (nodeConnector == null) {
1834 Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1835 Bandwidth bw = (Bandwidth) propMap.get(Bandwidth.BandwidthPropName);
1836 Config config = (Config) propMap.get(Config.ConfigPropName);
1837 State state = (State) propMap.get(State.StatePropName);
1838 String out = nodeConnector + " ";
1839 out += (bw != null) ? bw.getValue() / Math.pow(10, 9) : " ";
1841 out += (config != null) ? config.getValue() : " ";
1843 out += (state != null) ? state.getValue() : " ";
1846 ci.println("Total number of NodeConnectors: " + nodeConnectorSet.size());
1849 public void _pdm(CommandInterpreter ci) {
1850 String st = ci.nextArgument();
1852 ci.println("Please enter node id");
1856 Node node = Node.fromString(st);
1858 ci.println("Please enter node id");
1862 Switch sw = getSwitchByNode(node);
1864 ci.println(" NodeConnector Name");
1868 Set<NodeConnector> nodeConnectorSet = sw.getNodeConnectors();
1869 String nodeConnectorName;
1870 if (nodeConnectorSet != null && nodeConnectorSet.size() > 0) {
1871 for (NodeConnector nodeConnector : nodeConnectorSet) {
1872 Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1873 nodeConnectorName = (propMap == null) ? null : ((Name) propMap
1874 .get(Name.NamePropName)).getValue();
1875 if (nodeConnectorName != null) {
1876 Node nd = nodeConnector.getNode();
1877 if (!nd.equals(node)) {
1878 log.debug("node not match {} {}", nd, node);
1880 Map<String, NodeConnector> map = nodeConnectorNames
1883 NodeConnector nc = map.get(nodeConnectorName);
1885 log.debug("no nodeConnector named {}",
1887 } else if (!nc.equals(nodeConnector)) {
1888 log.debug("nodeConnector not match {} {}", nc,
1894 ci.println(nodeConnector
1896 + ((nodeConnectorName == null) ? "" : nodeConnectorName)
1897 + "(" + nodeConnector.getID() + ")");
1899 ci.println("Total number of NodeConnectors: "
1900 + nodeConnectorSet.size());
1904 public void _snt(CommandInterpreter ci) {
1905 String st = ci.nextArgument();
1907 ci.println("Please enter node id");
1911 Node node = Node.fromString(st);
1913 ci.println("Please enter node id");
1917 st = ci.nextArgument();
1919 ci.println("Please enter tier number");
1922 Integer tid = Integer.decode(st);
1923 Tier tier = new Tier(tid);
1924 setNodeProp(node, tier);
1927 public void _hostRefresh(CommandInterpreter ci) {
1928 String mode = ci.nextArgument();
1930 ci.println("expecting on/off/?");
1933 if (mode.toLowerCase().equals("on")) {
1935 } else if (mode.toLowerCase().equals("off")) {
1936 hostRefresh = false;
1937 } else if (mode.equals("?")) {
1939 ci.println("host refresh is ON");
1941 ci.println("host refresh is OFF");
1944 ci.println("expecting on/off/?");
1949 public void _hostRetry(CommandInterpreter ci) {
1950 String retry = ci.nextArgument();
1951 if (retry == null) {
1952 ci.println("Please enter a valid number. Current retry count is "
1957 hostRetryCount = Integer.parseInt(retry);
1958 } catch (Exception e) {
1959 ci.println("Please enter a valid number");
1965 public byte[] getNodeMAC(Node node) {
1966 MacAddress mac = (MacAddress) this.getNodeProp(node,
1968 return (mac != null) ? mac.getMacAddress() : null;
1972 public boolean isSpecial(NodeConnector p) {
1973 if (p.getType().equals(NodeConnectorIDType.CONTROLLER)
1974 || p.getType().equals(NodeConnectorIDType.ALL)
1975 || p.getType().equals(NodeConnectorIDType.SWSTACK)
1976 || p.getType().equals(NodeConnectorIDType.HWPATH)) {
1983 * Add span configuration to local cache and notify clients
1985 private void addSpanPorts(Node node, List<NodeConnector> nodeConnectors) {
1986 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
1988 for (NodeConnector nodeConnector : nodeConnectors) {
1989 if (!spanNodeConnectors.contains(nodeConnector)) {
1990 ncLists.add(nodeConnector);
1994 if (ncLists.size() > 0) {
1995 spanNodeConnectors.addAll(ncLists);
1996 notifySpanPortChange(node, ncLists, true);
2000 private void addSpanPorts(Node node) {
2001 for (SpanConfig conf : getSpanConfigList(node)) {
2002 addSpanPorts(node, conf.getPortArrayList());
2006 private void addSpanPort(NodeConnector nodeConnector) {
2007 // only add if span is configured on this nodeConnector
2008 for (SpanConfig conf : getSpanConfigList(nodeConnector.getNode())) {
2009 if (conf.getPortArrayList().contains(nodeConnector)) {
2010 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2011 ncLists.add(nodeConnector);
2012 addSpanPorts(nodeConnector.getNode(), ncLists);
2019 * Remove span configuration to local cache and notify clients
2021 private void removeSpanPorts(Node node, List<NodeConnector> nodeConnectors) {
2022 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2024 for (NodeConnector nodeConnector : nodeConnectors) {
2025 if (spanNodeConnectors.contains(nodeConnector)) {
2026 ncLists.add(nodeConnector);
2030 if (ncLists.size() > 0) {
2031 spanNodeConnectors.removeAll(ncLists);
2032 notifySpanPortChange(node, ncLists, false);
2036 private void removeSpanPorts(Node node) {
2037 for (SpanConfig conf : getSpanConfigList(node)) {
2038 addSpanPorts(node, conf.getPortArrayList());
2042 private void removeSpanPort(NodeConnector nodeConnector) {
2043 if (spanNodeConnectors.contains(nodeConnector)) {
2044 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2045 ncLists.add(nodeConnector);
2046 removeSpanPorts(nodeConnector.getNode(), ncLists);
2050 private void addNodeProps(Node node, Map<String, Property> propMap) {
2051 if (propMap == null) {
2052 propMap = new HashMap<String, Property>();
2054 nodeProps.put(node, propMap);
2058 public Status saveConfiguration() {
2059 return saveSwitchConfig();
2063 * Creates a Name/Tier/Bandwidth Property object based on given property
2064 * name and value. Other property types are not supported yet.
2067 * Name of the Property
2069 * Value of the Property
2070 * @return {@link org.opendaylight.controller.sal.core.Property}
2073 public Property createProperty(String propName, String propValue) {
2074 if (propName == null) {
2075 log.debug("propName is null");
2078 if (propValue == null) {
2079 log.debug("propValue is null");
2084 if (propName.equalsIgnoreCase(Description.propertyName)) {
2085 return new Description(propValue);
2086 } else if (propName.equalsIgnoreCase(Tier.TierPropName)) {
2087 int tier = Integer.parseInt(propValue);
2088 return new Tier(tier);
2089 } else if (propName.equalsIgnoreCase(Bandwidth.BandwidthPropName)) {
2090 long bw = Long.parseLong(propValue);
2091 return new Bandwidth(bw);
2092 } else if (propName.equalsIgnoreCase(ForwardingMode.name)) {
2093 int mode = Integer.parseInt(propValue);
2094 return new ForwardingMode(mode);
2096 log.debug("Not able to create {} property", propName);
2098 } catch (Exception e) {
2099 log.debug("createProperty caught exception {}", e.getMessage());
2106 public String getNodeDescription(Node node) {
2107 // Check first if user configured a name
2108 SwitchConfig config = getSwitchConfig(node.toString());
2109 if (config != null) {
2110 String configuredDesc = config.getNodeDescription();
2111 if (configuredDesc != null && !configuredDesc.isEmpty()) {
2112 return configuredDesc;
2116 // No name configured by user, get the node advertised name
2117 Description desc = (Description) getNodeProp(node,
2118 Description.propertyName);
2119 return (desc == null /* || desc.getValue().equalsIgnoreCase("none") */) ? ""