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.util.ArrayList;
16 import java.util.Collections;
17 import java.util.Dictionary;
18 import java.util.EnumSet;
19 import java.util.HashMap;
20 import java.util.HashSet;
21 import java.util.List;
24 import java.util.concurrent.ConcurrentHashMap;
25 import java.util.concurrent.ConcurrentMap;
26 import java.util.concurrent.CopyOnWriteArrayList;
28 import org.apache.felix.dm.Component;
29 import org.eclipse.osgi.framework.console.CommandInterpreter;
30 import org.eclipse.osgi.framework.console.CommandProvider;
31 import org.opendaylight.controller.clustering.services.CacheConfigException;
32 import org.opendaylight.controller.clustering.services.CacheExistException;
33 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
34 import org.opendaylight.controller.clustering.services.IClusterServices;
35 import org.opendaylight.controller.configuration.ConfigurationObject;
36 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
37 import org.opendaylight.controller.configuration.IConfigurationContainerService;
38 import org.opendaylight.controller.sal.core.Bandwidth;
39 import org.opendaylight.controller.sal.core.Config;
40 import org.opendaylight.controller.sal.core.ConstructionException;
41 import org.opendaylight.controller.sal.core.Description;
42 import org.opendaylight.controller.sal.core.ForwardingMode;
43 import org.opendaylight.controller.sal.core.MacAddress;
44 import org.opendaylight.controller.sal.core.Name;
45 import org.opendaylight.controller.sal.core.Node;
46 import org.opendaylight.controller.sal.core.NodeConnector;
47 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
48 import org.opendaylight.controller.sal.core.Property;
49 import org.opendaylight.controller.sal.core.State;
50 import org.opendaylight.controller.sal.core.Tier;
51 import org.opendaylight.controller.sal.core.UpdateType;
52 import org.opendaylight.controller.sal.inventory.IInventoryService;
53 import org.opendaylight.controller.sal.inventory.IListenInventoryUpdates;
54 import org.opendaylight.controller.sal.reader.NodeDescription;
55 import org.opendaylight.controller.sal.utils.GlobalConstants;
56 import org.opendaylight.controller.sal.utils.IObjectReader;
57 import org.opendaylight.controller.sal.utils.Status;
58 import org.opendaylight.controller.sal.utils.StatusCode;
59 import org.opendaylight.controller.statisticsmanager.IStatisticsManager;
60 import org.opendaylight.controller.switchmanager.IInventoryListener;
61 import org.opendaylight.controller.switchmanager.ISpanAware;
62 import org.opendaylight.controller.switchmanager.ISwitchManager;
63 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
64 import org.opendaylight.controller.switchmanager.SpanConfig;
65 import org.opendaylight.controller.switchmanager.Subnet;
66 import org.opendaylight.controller.switchmanager.SubnetConfig;
67 import org.opendaylight.controller.switchmanager.Switch;
68 import org.opendaylight.controller.switchmanager.SwitchConfig;
69 import org.osgi.framework.BundleContext;
70 import org.osgi.framework.FrameworkUtil;
71 import org.slf4j.Logger;
72 import org.slf4j.LoggerFactory;
75 * The class describes SwitchManager which is the central repository of all the
76 * inventory data including nodes, node connectors, properties attached, Layer3
77 * configurations, Span configurations, node configurations, network device
78 * representations viewed by Controller Web applications. One SwitchManager
79 * instance per container of the network. All the node/nodeConnector properties
80 * are maintained in the default container only.
82 public class SwitchManager implements ISwitchManager, IConfigurationContainerAware,
83 IObjectReader, IListenInventoryUpdates, CommandProvider {
84 private static Logger log = LoggerFactory.getLogger(SwitchManager.class);
85 private static final String SUBNETS_FILE_NAME = "subnets.conf";
86 private static final String SPAN_FILE_NAME = "spanPorts.conf";
87 private static final String SWITCH_CONFIG_FILE_NAME = "switchConfig.conf";
88 private final List<NodeConnector> spanNodeConnectors = new CopyOnWriteArrayList<NodeConnector>();
89 // Collection of Subnets keyed by the InetAddress
90 private ConcurrentMap<InetAddress, Subnet> subnets;
91 private ConcurrentMap<String, SubnetConfig> subnetsConfigList;
92 private ConcurrentMap<SpanConfig, SpanConfig> spanConfigList;
93 // manually configured parameters for the node such as name, tier, mode
94 private ConcurrentMap<String, SwitchConfig> nodeConfigList;
95 private ConcurrentMap<Node, Map<String, Property>> nodeProps;
96 private ConcurrentMap<NodeConnector, Map<String, Property>> nodeConnectorProps;
97 private ConcurrentMap<Node, Map<String, NodeConnector>> nodeConnectorNames;
98 private ConcurrentMap<String, Property> controllerProps;
99 private IInventoryService inventoryService;
100 private IStatisticsManager statisticsManager;
101 private IControllerProperties controllerProperties;
102 private IConfigurationContainerService configurationService;
103 private final Set<ISwitchManagerAware> switchManagerAware = Collections
104 .synchronizedSet(new HashSet<ISwitchManagerAware>());
105 private final Set<IInventoryListener> inventoryListeners = Collections
106 .synchronizedSet(new HashSet<IInventoryListener>());
107 private final Set<ISpanAware> spanAware = Collections.synchronizedSet(new HashSet<ISpanAware>());
108 private IClusterContainerServices clusterContainerService = null;
109 private String containerName = null;
110 private boolean isDefaultContainer = true;
111 private static final int REPLACE_RETRY = 1;
113 /* Information about the default subnet. If there have been no configured subnets, i.e.,
114 * subnets.size() == 0 or subnetsConfigList.size() == 0, then this subnet will be the
115 * only subnet returned. As soon as a user-configured subnet is created this one will
118 private static final String DISABLE_DEFAULT_SUBNET_PROP = "switchmanager.disableDefaultSubnetGateway";
119 private static final String DISABLE_DEFAULT_SUBNET_PROP_VAL = System.getProperty(DISABLE_DEFAULT_SUBNET_PROP);
120 private static final boolean USE_DEFAULT_SUBNET_GW = !Boolean.valueOf(DISABLE_DEFAULT_SUBNET_PROP_VAL);
121 protected static final SubnetConfig DEFAULT_SUBNETCONFIG;
122 protected static final Subnet DEFAULT_SUBNET;
123 protected static final String DEFAULT_SUBNET_NAME = "default (cannot be modifed)";
125 DEFAULT_SUBNETCONFIG = new SubnetConfig(DEFAULT_SUBNET_NAME, "0.0.0.0/0", new ArrayList<String>());
126 DEFAULT_SUBNET = new Subnet(DEFAULT_SUBNETCONFIG);
129 public void notifySubnetChange(Subnet sub, boolean add) {
130 synchronized (switchManagerAware) {
131 for (Object subAware : switchManagerAware) {
133 ((ISwitchManagerAware) subAware).subnetNotify(sub, add);
134 } catch (Exception e) {
135 log.error("Failed to notify Subnet change {}",
142 public void notifySpanPortChange(Node node, List<NodeConnector> ports, boolean add) {
143 synchronized (spanAware) {
144 for (Object sa : spanAware) {
146 ((ISpanAware) sa).spanUpdate(node, ports, add);
147 } catch (Exception e) {
148 log.error("Failed to notify Span Interface change {}",
155 private void notifyModeChange(Node node, boolean proactive) {
156 synchronized (switchManagerAware) {
157 for (ISwitchManagerAware service : switchManagerAware) {
159 service.modeChangeNotify(node, proactive);
160 } catch (Exception e) {
161 log.error("Failed to notify Subnet change {}",
168 public void startUp() {
169 // Instantiate cluster synced variables
173 // Add controller MAC, if first node in the cluster
174 if ((!controllerProps.containsKey(MacAddress.name)) && (controllerProperties != null)) {
175 Property controllerMac = controllerProperties.getControllerProperty(MacAddress.name);
176 if (controllerMac != null) {
177 Property existing = controllerProps.putIfAbsent(MacAddress.name, controllerMac);
178 if (existing == null && log.isTraceEnabled()) {
179 log.trace("Container {}: Setting controller MAC address in the cluster: {}", getContainerName(),
186 public void shutDown() {
189 private void allocateCaches() {
190 if (this.clusterContainerService == null) {
191 this.nonClusterObjectCreate();
192 log.warn("un-initialized clusterContainerService, can't create cache");
197 clusterContainerService.createCache(
198 "switchmanager.subnetsConfigList",
199 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
200 clusterContainerService.createCache("switchmanager.spanConfigList",
201 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
202 clusterContainerService.createCache("switchmanager.nodeConfigList",
203 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
204 clusterContainerService.createCache("switchmanager.subnets",
205 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
206 clusterContainerService.createCache("switchmanager.nodeProps",
207 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
208 clusterContainerService.createCache(
209 "switchmanager.nodeConnectorProps",
210 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
211 clusterContainerService.createCache(
212 "switchmanager.nodeConnectorNames",
213 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
214 clusterContainerService.createCache(
215 "switchmanager.controllerProps",
216 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
217 } catch (CacheConfigException cce) {
218 log.error("\nCache configuration invalid - check cache mode");
219 } catch (CacheExistException ce) {
220 log.error("\nCache already exits - destroy and recreate if needed");
224 @SuppressWarnings({ "unchecked" })
225 private void retrieveCaches() {
226 if (this.clusterContainerService == null) {
227 log.warn("un-initialized clusterContainerService, can't create cache");
231 subnetsConfigList = (ConcurrentMap<String, SubnetConfig>) clusterContainerService
232 .getCache("switchmanager.subnetsConfigList");
233 if (subnetsConfigList == null) {
234 log.error("\nFailed to get cache for subnetsConfigList");
237 spanConfigList = (ConcurrentMap<SpanConfig, SpanConfig>) clusterContainerService
238 .getCache("switchmanager.spanConfigList");
239 if (spanConfigList == null) {
240 log.error("\nFailed to get cache for spanConfigList");
243 nodeConfigList = (ConcurrentMap<String, SwitchConfig>) clusterContainerService
244 .getCache("switchmanager.nodeConfigList");
245 if (nodeConfigList == null) {
246 log.error("\nFailed to get cache for nodeConfigList");
249 subnets = (ConcurrentMap<InetAddress, Subnet>) clusterContainerService
250 .getCache("switchmanager.subnets");
251 if (subnets == null) {
252 log.error("\nFailed to get cache for subnets");
255 nodeProps = (ConcurrentMap<Node, Map<String, Property>>) clusterContainerService
256 .getCache("switchmanager.nodeProps");
257 if (nodeProps == null) {
258 log.error("\nFailed to get cache for nodeProps");
261 nodeConnectorProps = (ConcurrentMap<NodeConnector, Map<String, Property>>) clusterContainerService
262 .getCache("switchmanager.nodeConnectorProps");
263 if (nodeConnectorProps == null) {
264 log.error("\nFailed to get cache for nodeConnectorProps");
267 nodeConnectorNames = (ConcurrentMap<Node, Map<String, NodeConnector>>) clusterContainerService
268 .getCache("switchmanager.nodeConnectorNames");
269 if (nodeConnectorNames == null) {
270 log.error("\nFailed to get cache for nodeConnectorNames");
273 controllerProps = (ConcurrentMap<String, Property>) clusterContainerService
274 .getCache("switchmanager.controllerProps");
275 if (controllerProps == null) {
276 log.error("\nFailed to get cache for controllerProps");
280 private void nonClusterObjectCreate() {
281 subnetsConfigList = new ConcurrentHashMap<String, SubnetConfig>();
282 spanConfigList = new ConcurrentHashMap<SpanConfig, SpanConfig>();
283 nodeConfigList = new ConcurrentHashMap<String, SwitchConfig>();
284 subnets = new ConcurrentHashMap<InetAddress, Subnet>();
285 nodeProps = new ConcurrentHashMap<Node, Map<String, Property>>();
286 nodeConnectorProps = new ConcurrentHashMap<NodeConnector, Map<String, Property>>();
287 nodeConnectorNames = new ConcurrentHashMap<Node, Map<String, NodeConnector>>();
288 controllerProps = new ConcurrentHashMap<String, Property>();
292 public List<SubnetConfig> getSubnetsConfigList() {
293 // if there are no subnets, return the default subnet
294 if (USE_DEFAULT_SUBNET_GW && subnetsConfigList.isEmpty()) {
295 return Collections.singletonList(DEFAULT_SUBNETCONFIG);
297 return new ArrayList<SubnetConfig>(subnetsConfigList.values());
302 public SubnetConfig getSubnetConfig(String subnet) {
303 // if there are no subnets, return the default subnet
304 if (USE_DEFAULT_SUBNET_GW && subnetsConfigList.isEmpty() && subnet.equalsIgnoreCase(DEFAULT_SUBNET_NAME)) {
305 return DEFAULT_SUBNETCONFIG;
307 return subnetsConfigList.get(subnet);
311 private List<SpanConfig> getSpanConfigList(Node node) {
312 List<SpanConfig> confList = new ArrayList<SpanConfig>();
313 String nodeId = node.toString();
314 for (SpanConfig conf : spanConfigList.values()) {
315 if (conf.matchNode(nodeId)) {
322 public List<SwitchConfig> getNodeConfigList() {
323 return new ArrayList<SwitchConfig>(nodeConfigList.values());
327 public SwitchConfig getSwitchConfig(String switchId) {
328 return nodeConfigList.get(switchId);
331 public Switch getSwitchByNode(Node node) {
332 Switch sw = new Switch(node);
334 MacAddress mac = (MacAddress) this.getNodeProp(node,
337 sw.setDataLayerAddress(mac.getMacAddress());
339 Set<NodeConnector> ncSet = getPhysicalNodeConnectors(node);
340 sw.setNodeConnectors(ncSet);
342 List<NodeConnector> ncList = new ArrayList<NodeConnector>();
343 for (NodeConnector nodeConnector : ncSet) {
344 if (spanNodeConnectors.contains(nodeConnector)) {
345 ncList.add(nodeConnector);
348 sw.addSpanPorts(ncList);
354 public List<Switch> getNetworkDevices() {
355 List<Switch> swList = new ArrayList<Switch>();
356 for (Node node : getNodes()) {
357 swList.add(getSwitchByNode(node));
362 private Status updateConfig(SubnetConfig conf, boolean add) {
364 if(subnetsConfigList.putIfAbsent(conf.getName(), conf) != null) {
365 String msg = "Cluster conflict: Subnet with name " + conf.getName() + "already exists.";
366 return new Status(StatusCode.CONFLICT, msg);
369 subnetsConfigList.remove(conf.getName());
371 return new Status(StatusCode.SUCCESS);
374 private Status updateDatabase(SubnetConfig conf, boolean add) {
376 Subnet subnetCurr = subnets.get(conf.getIPAddress());
378 if (subnetCurr == null) {
379 subnet = new Subnet(conf);
381 subnet = subnetCurr.clone();
383 // In case of API3 call we may receive the ports along with the
385 if (!conf.isGlobal()) {
386 subnet.addNodeConnectors(conf.getNodeConnectors());
388 boolean putNewSubnet = false;
389 if(subnetCurr == null) {
390 if(subnets.putIfAbsent(conf.getIPAddress(), subnet) == null) {
394 putNewSubnet = subnets.replace(conf.getIPAddress(), subnetCurr, subnet);
397 String msg = "Cluster conflict: Conflict while adding the subnet " + conf.getIPAddress();
398 return new Status(StatusCode.CONFLICT, msg);
401 // Subnet removal case
403 subnets.remove(conf.getIPAddress());
405 return new Status(StatusCode.SUCCESS);
408 private Status semanticCheck(SubnetConfig conf) {
409 Set<InetAddress> IPs = subnets.keySet();
411 return new Status(StatusCode.SUCCESS);
413 Subnet newSubnet = new Subnet(conf);
414 for (InetAddress i : IPs) {
415 Subnet existingSubnet = subnets.get(i);
416 if ((existingSubnet != null) && !existingSubnet.isMutualExclusive(newSubnet)) {
417 return new Status(StatusCode.CONFLICT, "This subnet conflicts with an existing one.");
420 return new Status(StatusCode.SUCCESS);
423 private Status addRemoveSubnet(SubnetConfig conf, boolean isAdding) {
424 // Valid configuration check
425 Status status = conf.validate();
426 if (!status.isSuccess()) {
427 log.warn(status.getDescription());
433 if (subnetsConfigList.containsKey(conf.getName())) {
434 return new Status(StatusCode.CONFLICT,
435 "Subnet with the specified name already exists.");
438 status = semanticCheck(conf);
439 if (!status.isSuccess()) {
443 if (conf.getName().equalsIgnoreCase(DEFAULT_SUBNET_NAME)) {
444 return new Status(StatusCode.NOTALLOWED, "The specified subnet gateway cannot be removed");
449 status = updateDatabase(conf, isAdding);
451 if (status.isSuccess()) {
452 // Update Configuration
453 status = updateConfig(conf, isAdding);
454 if(!status.isSuccess()) {
455 updateDatabase(conf, (!isAdding));
457 // update the listeners
458 Subnet subnetCurr = subnets.get(conf.getIPAddress());
460 if (subnetCurr == null) {
461 subnet = new Subnet(conf);
463 subnet = subnetCurr.clone();
465 notifySubnetChange(subnet, isAdding);
473 * Adds Subnet configured in GUI or API3
476 public Status addSubnet(SubnetConfig conf) {
477 return this.addRemoveSubnet(conf, true);
481 public Status removeSubnet(SubnetConfig conf) {
482 return this.addRemoveSubnet(conf, false);
486 public Status removeSubnet(String name) {
487 if (name.equalsIgnoreCase(DEFAULT_SUBNET_NAME)) {
488 return new Status(StatusCode.NOTALLOWED, "The specified subnet gateway cannot be removed");
490 SubnetConfig conf = subnetsConfigList.get(name);
492 return new Status(StatusCode.SUCCESS, "Subnet not present");
494 return this.addRemoveSubnet(conf, false);
498 public Status modifySubnet(SubnetConfig conf) {
501 return new Status(StatusCode.BADREQUEST, "Invalid Subnet configuration: null");
504 // Valid configuration check
505 Status status = conf.validate();
506 if (!status.isSuccess()) {
507 log.warn(status.getDescription());
511 // If a subnet configuration with this name does not exist, consider this is a creation
512 SubnetConfig target = subnetsConfigList.get(conf.getName());
513 if (target == null) {
514 return this.addSubnet(conf);
518 if (target.equals(conf)) {
519 return new Status(StatusCode.SUCCESS);
522 // Check not allowed modifications
523 if (!target.getSubnet().equals(conf.getSubnet())) {
524 return new Status(StatusCode.BADREQUEST, "IP address change is not allowed");
527 // Derive the set of node connectors that are being removed
528 Set<NodeConnector> toRemove = target.getNodeConnectors();
529 toRemove.removeAll(conf.getNodeConnectors());
530 List<String> nodeConnectorStrings = null;
531 if (!toRemove.isEmpty()) {
532 nodeConnectorStrings = new ArrayList<String>();
533 for (NodeConnector nc : toRemove) {
534 nodeConnectorStrings.add(nc.toString());
536 status = this.removePortsFromSubnet(conf.getName(), nodeConnectorStrings);
537 if (!status.isSuccess()) {
542 // Derive the set of node connectors that are being added
543 Set<NodeConnector> toAdd = conf.getNodeConnectors();
544 toAdd.removeAll(target.getNodeConnectors());
545 if (!toAdd.isEmpty()) {
546 List<String> nodeConnectorStringRemoved = nodeConnectorStrings;
547 nodeConnectorStrings = new ArrayList<String>();
548 for (NodeConnector nc : toAdd) {
549 nodeConnectorStrings.add(nc.toString());
551 status = this.addPortsToSubnet(conf.getName(), nodeConnectorStrings);
552 if (!status.isSuccess()) {
553 // If any port was removed, add it back as a best recovery effort
554 if (!toRemove.isEmpty()) {
555 this.addPortsToSubnet(conf.getName(), nodeConnectorStringRemoved);
561 // Update Configuration
562 subnetsConfigList.put(conf.getName(), conf);
564 return new Status(StatusCode.SUCCESS);
568 public Status addPortsToSubnet(String name, List<String> switchPorts) {
570 return new Status(StatusCode.BADREQUEST, "Null subnet name");
572 SubnetConfig confCurr = subnetsConfigList.get(name);
573 if (confCurr == null) {
574 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
577 if (switchPorts == null || switchPorts.isEmpty()) {
578 return new Status(StatusCode.BADREQUEST, "Null or empty port set");
581 Subnet subCurr = subnets.get(confCurr.getIPAddress());
582 if (subCurr == null) {
583 log.debug("Cluster conflict: Subnet entry {} is not present in the subnets cache.", confCurr.getIPAddress());
584 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
588 Subnet sub = subCurr.clone();
589 Set<NodeConnector> sp = NodeConnector.fromString(switchPorts);
590 sub.addNodeConnectors(sp);
591 boolean subnetsReplaced = subnets.replace(confCurr.getIPAddress(), subCurr, sub);
592 if (!subnetsReplaced) {
593 String msg = "Cluster conflict: Conflict while adding ports to the subnet " + name;
594 return new Status(StatusCode.CONFLICT, msg);
597 // Update Configuration
598 SubnetConfig conf = confCurr.clone();
599 conf.addNodeConnectors(switchPorts);
600 boolean configReplaced = subnetsConfigList.replace(name, confCurr, conf);
601 if (!configReplaced) {
602 // TODO: recovery using Transactionality
603 String msg = "Cluster conflict: Conflict while adding ports to the subnet " + name;
604 return new Status(StatusCode.CONFLICT, msg);
607 return new Status(StatusCode.SUCCESS);
611 public Status removePortsFromSubnet(String name, List<String> switchPorts) {
613 return new Status(StatusCode.BADREQUEST, "Null subnet name");
615 SubnetConfig confCurr = subnetsConfigList.get(name);
616 if (confCurr == null) {
617 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
620 if (switchPorts == null || switchPorts.isEmpty()) {
621 return new Status(StatusCode.BADREQUEST, "Null or empty port set");
624 Subnet subCurr = subnets.get(confCurr.getIPAddress());
625 if (subCurr == null) {
626 log.debug("Cluster conflict: Subnet entry {} is not present in the subnets cache.", confCurr.getIPAddress());
627 return new Status(StatusCode.NOTFOUND, "Subnet does not exist");
631 Status status = SubnetConfig.validatePorts(switchPorts);
632 if (!status.isSuccess()) {
636 Subnet sub = subCurr.clone();
637 Set<NodeConnector> sp = NodeConnector.fromString(switchPorts);
638 sub.deleteNodeConnectors(sp);
639 boolean subnetsReplace = subnets.replace(confCurr.getIPAddress(), subCurr, sub);
640 if (!subnetsReplace) {
641 String msg = "Cluster conflict: Conflict while removing ports from the subnet " + name;
642 return new Status(StatusCode.CONFLICT, msg);
645 // Update Configuration
646 SubnetConfig conf = confCurr.clone();
647 conf.removeNodeConnectors(switchPorts);
648 boolean result = subnetsConfigList.replace(name, confCurr, conf);
650 // TODO: recovery using Transactionality
651 String msg = "Cluster conflict: Conflict while removing ports from " + conf;
652 return new Status(StatusCode.CONFLICT, msg);
655 return new Status(StatusCode.SUCCESS);
658 public String getContainerName() {
659 if (containerName == null) {
660 return GlobalConstants.DEFAULT.toString();
662 return containerName;
666 public Subnet getSubnetByNetworkAddress(InetAddress networkAddress) {
667 // if there are no subnets, return the default subnet
668 if (subnets.size() == 0) {
669 return DEFAULT_SUBNET;
672 for(Map.Entry<InetAddress,Subnet> subnetEntry : subnets.entrySet()) {
673 if(subnetEntry.getValue().isSubnetOf(networkAddress)) {
674 return subnetEntry.getValue();
681 public Object readObject(ObjectInputStream ois)
682 throws FileNotFoundException, IOException, ClassNotFoundException {
683 // Perform the class deserialization locally, from inside the package
684 // where the class is defined
685 return ois.readObject();
688 private void loadSubnetConfiguration() {
689 for (ConfigurationObject conf : configurationService.retrieveConfiguration(this, SUBNETS_FILE_NAME)) {
690 addSubnet((SubnetConfig) conf);
694 private void loadSpanConfiguration() {
695 for (ConfigurationObject conf : configurationService.retrieveConfiguration(this, SPAN_FILE_NAME)) {
696 addSpanConfig((SpanConfig) conf);
700 private void loadSwitchConfiguration() {
701 for (ConfigurationObject conf : configurationService.retrieveConfiguration(this, SWITCH_CONFIG_FILE_NAME)) {
702 updateNodeConfig((SwitchConfig) conf);
706 @SuppressWarnings("deprecation")
708 public void updateSwitchConfig(SwitchConfig cfgObject) {
709 // update default container only
710 if (!isDefaultContainer) {
714 SwitchConfig sc = nodeConfigList.get(cfgObject.getNodeId());
716 if (nodeConfigList.putIfAbsent(cfgObject.getNodeId(), cfgObject) != null) {
720 if (!nodeConfigList.replace(cfgObject.getNodeId(), sc, cfgObject)) {
725 boolean modeChange = false;
727 if ((sc == null) || !cfgObject.getMode().equals(sc.getMode())) {
731 String nodeId = cfgObject.getNodeId();
732 Node node = Node.fromString(nodeId);
733 Map<String, Property> propMapCurr = nodeProps.get(node);
734 if (propMapCurr == null) {
737 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
738 Property desc = new Description(cfgObject.getNodeDescription());
739 propMap.put(desc.getName(), desc);
740 Property tier = new Tier(Integer.parseInt(cfgObject.getTier()));
741 propMap.put(tier.getName(), tier);
743 if (!nodeProps.replace(node, propMapCurr, propMap)) {
744 // TODO rollback using Transactionality
748 log.trace("Set Node {}'s Mode to {}", nodeId, cfgObject.getMode());
751 notifyModeChange(node, cfgObject.isProactive());
756 public Status updateNodeConfig(SwitchConfig switchConfig) {
757 Status status = switchConfig.validate();
758 if (!status.isSuccess()) {
762 Map<String, Property> updateProperties = switchConfig.getNodeProperties();
763 ForwardingMode mode = (ForwardingMode) updateProperties.get(ForwardingMode.name);
765 if (isDefaultContainer) {
766 if (!mode.isValid()) {
767 return new Status(StatusCode.BADREQUEST, "Invalid Forwarding Mode Value");
770 return new Status(StatusCode.NOTACCEPTABLE,
771 "Forwarding Mode modification is allowed only in default container");
775 Description description = (Description) switchConfig.getProperty(Description.propertyName);
776 String nodeId = switchConfig.getNodeId();
777 Node node = Node.fromString(nodeId);
778 NodeDescription nodeDesc = (this.statisticsManager == null) ? null : this.statisticsManager
779 .getNodeDescription(node);
780 String advertisedDesc = (nodeDesc == null) ? "" : nodeDesc.getDescription();
781 if (description != null && description.getValue() != null) {
782 if (description.getValue().isEmpty() || description.getValue().equals(advertisedDesc)) {
783 updateProperties.remove(Description.propertyName);
784 switchConfig = new SwitchConfig(nodeId, updateProperties);
786 // check if description is configured or was published by any other node
787 for (Map.Entry<Node, Map<String, Property>> entry : nodeProps.entrySet()) {
788 Node n = entry.getKey();
789 Description desc = (Description) getNodeProp(n, Description.propertyName);
790 NodeDescription nDesc = (this.statisticsManager == null) ? null : this.statisticsManager
791 .getNodeDescription(n);
792 String advDesc = (nDesc == null) ? "" : nDesc.getDescription();
793 if ((description.equals(desc) || description.getValue().equals(advDesc)) && !node.equals(n)) {
794 return new Status(StatusCode.CONFLICT, "Node name already in use");
800 boolean modeChange = false;
801 SwitchConfig sc = nodeConfigList.get(nodeId);
802 Map<String, Property> prevNodeProperties = new HashMap<String, Property>();
804 if ((mode != null) && mode.isProactive()) {
807 if (!updateProperties.isEmpty()) {
808 if (nodeConfigList.putIfAbsent(nodeId, switchConfig) != null) {
809 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
813 prevNodeProperties = new HashMap<String, Property>(sc.getNodeProperties());
814 ForwardingMode prevMode = (ForwardingMode) sc.getProperty(ForwardingMode.name);
816 if ((prevMode != null) && (prevMode.isProactive())) {
820 if (((prevMode != null) && (prevMode.getValue() != mode.getValue()))
821 || (prevMode == null && mode.isProactive())) {
825 if (updateProperties.isEmpty()) {
826 nodeConfigList.remove(nodeId);
828 if (!nodeConfigList.replace(nodeId, sc, switchConfig)) {
829 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
833 Map<String, Property> propMapCurr = nodeProps.get(node);
834 if (propMapCurr == null) {
835 return new Status(StatusCode.SUCCESS);
837 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
838 for (Map.Entry<String, Property> entry : prevNodeProperties.entrySet()) {
839 String prop = entry.getKey();
840 if (!updateProperties.containsKey(prop)) {
841 if (prop.equals(Description.propertyName)) {
842 if (advertisedDesc != null) {
843 if (!advertisedDesc.isEmpty()) {
844 Property desc = new Description(advertisedDesc);
845 propMap.put(Description.propertyName, desc);
849 propMap.remove(prop);
852 } else if (prop.equals(ForwardingMode.name)) {
853 Property defaultMode = new ForwardingMode(ForwardingMode.REACTIVE_FORWARDING);
854 propMap.put(ForwardingMode.name, defaultMode);
857 propMap.remove(prop);
860 propMap.putAll(updateProperties);
861 if (!nodeProps.replace(node, propMapCurr, propMap)) {
862 // TODO rollback using Transactionality
863 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration");
866 notifyModeChange(node, (mode == null) ? false : mode.isProactive());
868 return new Status(StatusCode.SUCCESS);
872 public Status removeNodeConfig(String nodeId) {
873 if ((nodeId == null) || (nodeId.isEmpty())) {
874 return new Status(StatusCode.BADREQUEST, "nodeId cannot be empty.");
876 Map<String, Property> nodeProperties = getSwitchConfig(nodeId).getNodeProperties();
877 Node node = Node.fromString(nodeId);
878 Map<String, Property> propMapCurr = nodeProps.get(node);
879 if ((propMapCurr != null) && (nodeProperties != null) && (!nodeProperties.isEmpty())) {
880 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
881 for (Map.Entry<String, Property> entry : nodeProperties.entrySet()) {
882 String prop = entry.getKey();
883 if (prop.equals(Description.propertyName)) {
884 Map<Node, Map<String, Property>> nodeProp = this.inventoryService.getNodeProps();
885 if (nodeProp.get(node) != null) {
886 propMap.put(Description.propertyName, nodeProp.get(node).get(Description.propertyName));
890 propMap.remove(prop);
892 if (!nodeProps.replace(node, propMapCurr, propMap)) {
893 return new Status(StatusCode.CONFLICT, "Cluster conflict: Unable to update node configuration.");
896 if (nodeConfigList != null) {
897 nodeConfigList.remove(nodeId);
899 return new Status(StatusCode.SUCCESS);
903 public Status saveSwitchConfig() {
904 return saveSwitchConfigInternal();
907 public Status saveSwitchConfigInternal() {
910 status = configurationService.persistConfiguration(
911 new ArrayList<ConfigurationObject>(subnetsConfigList.values()), SUBNETS_FILE_NAME);
912 if (status.isSuccess()) {
915 log.warn("Failed to save subnet gateway configurations: " + status.getDescription());
917 status = configurationService.persistConfiguration(new ArrayList<ConfigurationObject>(spanConfigList.values()),
919 if (status.isSuccess()) {
922 log.warn("Failed to save span port configurations: " + status.getDescription());
924 status = configurationService.persistConfiguration(new ArrayList<ConfigurationObject>(nodeConfigList.values()),
925 SWITCH_CONFIG_FILE_NAME);
926 if (status.isSuccess()) {
929 log.warn("Failed to save node configurations: " + status.getDescription());
932 return new Status(StatusCode.INTERNALERROR, "Save failed");
935 return new Status(StatusCode.INTERNALERROR, "Partial save failure");
941 public List<SpanConfig> getSpanConfigList() {
942 return new ArrayList<SpanConfig>(spanConfigList.values());
946 public Status addSpanConfig(SpanConfig conf) {
947 // Valid config check
948 if (!conf.isValidConfig()) {
949 String msg = "Invalid Span configuration";
951 return new Status(StatusCode.BADREQUEST, msg);
955 if (spanConfigList.containsKey(conf)) {
956 return new Status(StatusCode.CONFLICT, "Same span config exists");
959 // Update configuration
960 if (spanConfigList.putIfAbsent(conf, conf) == null) {
961 // Update database and notify clients
962 addSpanPorts(conf.getNode(), conf.getPortArrayList());
965 return new Status(StatusCode.SUCCESS);
969 public Status removeSpanConfig(SpanConfig conf) {
970 removeSpanPorts(conf.getNode(), conf.getPortArrayList());
972 // Update configuration
973 spanConfigList.remove(conf);
975 return new Status(StatusCode.SUCCESS);
979 public List<NodeConnector> getSpanPorts(Node node) {
980 List<NodeConnector> ncList = new ArrayList<NodeConnector>();
982 for (NodeConnector nodeConnector : spanNodeConnectors) {
983 if (nodeConnector.getNode().equals(node)) {
984 ncList.add(nodeConnector);
990 private void addNode(Node node, Set<Property> props) {
991 log.trace("{} added, props: {}", node, props);
992 if (nodeProps == null) {
996 Map<String, Property> propMapCurr = nodeProps.get(node);
997 Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
998 : new HashMap<String, Property>(propMapCurr);
1000 // copy node properties from plugin
1001 if (props != null) {
1002 for (Property prop : props) {
1003 propMap.put(prop.getName(), prop);
1007 boolean forwardingModeChanged = false;
1009 // copy node properties from config
1010 if (nodeConfigList != null) {
1011 String nodeId = node.toString();
1012 SwitchConfig conf = nodeConfigList.get(nodeId);
1013 if (conf != null && (conf.getNodeProperties() != null)) {
1014 Map<String, Property> nodeProperties = conf.getNodeProperties();
1015 propMap.putAll(nodeProperties);
1016 if (nodeProperties.get(ForwardingMode.name) != null) {
1017 ForwardingMode mode = (ForwardingMode) nodeProperties.get(ForwardingMode.name);
1018 forwardingModeChanged = mode.isProactive();
1023 if (!propMap.containsKey(ForwardingMode.name)) {
1024 Property defaultMode = new ForwardingMode(ForwardingMode.REACTIVE_FORWARDING);
1025 propMap.put(ForwardingMode.name, defaultMode);
1028 boolean propsAdded = false;
1029 // Attempt initial add
1030 if (nodeProps.putIfAbsent(node, propMap) == null) {
1033 /* Notify listeners only for initial node addition
1034 * to avoid expensive tasks triggered by redundant notifications
1036 notifyNode(node, UpdateType.ADDED, propMap);
1039 propsAdded = nodeProps.replace(node, propMapCurr, propMap);
1041 // check whether forwarding mode changed
1042 if (propMapCurr.get(ForwardingMode.name) != null) {
1043 ForwardingMode mode = (ForwardingMode) propMapCurr.get(ForwardingMode.name);
1044 forwardingModeChanged ^= mode.isProactive();
1048 log.debug("Cluster conflict while adding node {}. Overwriting with latest props: {}", node.getID(), props);
1049 addNodeProps(node, propMap);
1052 // check if span ports are configured
1054 // notify proactive mode forwarding
1055 if (forwardingModeChanged) {
1056 notifyModeChange(node, true);
1060 private void removeNode(Node node) {
1061 log.trace("{} removed", node);
1062 if (nodeProps == null) {
1066 if (nodeProps.remove(node) == null) {
1067 log.debug("Received redundant node REMOVED udate for {}. Skipping..", node);
1071 nodeConnectorNames.remove(node);
1072 Set<NodeConnector> removeNodeConnectorSet = new HashSet<NodeConnector>();
1073 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1074 NodeConnector nodeConnector = entry.getKey();
1075 if (nodeConnector.getNode().equals(node)) {
1076 removeNodeConnectorSet.add(nodeConnector);
1079 for (NodeConnector nc : removeNodeConnectorSet) {
1080 nodeConnectorProps.remove(nc);
1083 // check if span ports need to be cleaned up
1084 removeSpanPorts(node);
1086 /* notify node listeners */
1087 notifyNode(node, UpdateType.REMOVED, null);
1090 private void updateNode(Node node, Set<Property> props) {
1091 log.trace("{} updated, props: {}", node, props);
1092 if (nodeProps == null || props == null) {
1096 Map<String, Property> propMapCurr = nodeProps.get(node);
1097 Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
1098 : new HashMap<String, Property>(propMapCurr);
1100 // copy node properties from plugin
1101 String nodeId = node.toString();
1102 for (Property prop : props) {
1103 if (nodeConfigList != null) {
1104 SwitchConfig conf = nodeConfigList.get(nodeId);
1105 if (conf != null && (conf.getNodeProperties() != null)
1106 && conf.getNodeProperties().containsKey(prop.getName())) {
1110 propMap.put(prop.getName(), prop);
1113 if (propMapCurr == null) {
1114 if (nodeProps.putIfAbsent(node, propMap) != null) {
1115 log.debug("Cluster conflict: Conflict while updating the node. Node: {} Properties: {}",
1116 node.getID(), props);
1117 addNodeProps(node, propMap);
1120 if (!nodeProps.replace(node, propMapCurr, propMap)) {
1121 log.debug("Cluster conflict: Conflict while updating the node. Node: {} Properties: {}",
1122 node.getID(), props);
1123 addNodeProps(node, propMap);
1127 /* notify node listeners */
1128 notifyNode(node, UpdateType.CHANGED, propMap);
1132 public void updateNode(Node node, UpdateType type, Set<Property> props) {
1133 log.debug("updateNode: {} type {} props {} for container {}",
1134 new Object[] { node, type, props, containerName });
1137 addNode(node, props);
1140 updateNode(node, props);
1151 public void updateNodeConnector(NodeConnector nodeConnector,
1152 UpdateType type, Set<Property> props) {
1153 Map<String, Property> propMap = new HashMap<String, Property>();
1154 boolean update = true;
1156 log.debug("updateNodeConnector: {} type {} props {} for container {}",
1157 new Object[] { nodeConnector, type, props, containerName });
1159 if (nodeConnectorProps == null) {
1165 // Skip redundant ADDED update (e.g. cluster switch-over)
1166 if (nodeConnectorProps.containsKey(nodeConnector)) {
1167 log.debug("Redundant nodeconnector ADDED for {}, props {} for container {}",
1168 nodeConnector, props, containerName);
1172 if (props != null) {
1173 for (Property prop : props) {
1174 addNodeConnectorProp(nodeConnector, prop);
1175 propMap.put(prop.getName(), prop);
1178 addNodeConnectorProp(nodeConnector, null);
1182 addSpanPort(nodeConnector);
1185 if (!nodeConnectorProps.containsKey(nodeConnector) || (props == null)) {
1188 for (Property prop : props) {
1189 addNodeConnectorProp(nodeConnector, prop);
1190 propMap.put(prop.getName(), prop);
1195 if (!nodeConnectorProps.containsKey(nodeConnector)) {
1198 removeNodeConnectorAllProps(nodeConnector);
1200 // clean up span config
1201 removeSpanPort(nodeConnector);
1209 notifyNodeConnector(nodeConnector, type, propMap);
1214 public Set<Node> getNodes() {
1215 return (nodeProps != null) ? new HashSet<Node>(nodeProps.keySet()) : new HashSet<Node>();
1219 public Map<String, Property> getControllerProperties() {
1220 return new HashMap<String, Property>(this.controllerProps);
1224 public Property getControllerProperty(String propertyName) {
1225 if (propertyName != null) {
1226 HashMap<String, Property> propertyMap = new HashMap<String, Property>(this.controllerProps);
1227 return propertyMap.get(propertyName);
1233 public Status setControllerProperty(Property property) {
1234 if (property != null) {
1235 this.controllerProps.put(property.getName(), property);
1236 return new Status(StatusCode.SUCCESS);
1238 return new Status(StatusCode.BADREQUEST, "Invalid property provided when setting property");
1242 public Status removeControllerProperty(String propertyName) {
1243 if (propertyName != null) {
1244 if (this.controllerProps.containsKey(propertyName)) {
1245 this.controllerProps.remove(propertyName);
1246 if (!this.controllerProps.containsKey(propertyName)) {
1247 return new Status(StatusCode.SUCCESS);
1250 String msg = "Unable to remove property " + propertyName + " from Controller";
1251 return new Status(StatusCode.BADREQUEST, msg);
1253 String msg = "Invalid property provided when removing property from Controller";
1254 return new Status(StatusCode.BADREQUEST, msg);
1258 * Returns a copy of a list of properties for a given node
1263 * org.opendaylight.controller.switchmanager.ISwitchManager#getNodeProps
1264 * (org.opendaylight.controller.sal.core.Node)
1267 public Map<String, Property> getNodeProps(Node node) {
1268 Map<String, Property> rv = new HashMap<String, Property>();
1269 if (this.nodeProps != null) {
1270 rv = this.nodeProps.get(node);
1272 /* make a copy of it */
1273 rv = new HashMap<String, Property>(rv);
1280 public Property getNodeProp(Node node, String propName) {
1281 Map<String, Property> propMap = getNodeProps(node);
1282 return (propMap != null) ? propMap.get(propName) : null;
1286 public void setNodeProp(Node node, Property prop) {
1288 for (int i = 0; i <= REPLACE_RETRY; i++) {
1289 /* Get a copy of the property map */
1290 Map<String, Property> propMapCurr = getNodeProps(node);
1291 if (propMapCurr == null) {
1295 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1296 propMap.put(prop.getName(), prop);
1298 if (nodeProps.replace(node, propMapCurr, propMap)) {
1302 log.warn("Cluster conflict: Unable to add property {} to node {}.", prop.getName(), node.getID());
1306 public Status removeNodeProp(Node node, String propName) {
1307 for (int i = 0; i <= REPLACE_RETRY; i++) {
1308 Map<String, Property> propMapCurr = getNodeProps(node);
1309 if (propMapCurr != null) {
1310 if (!propMapCurr.containsKey(propName)) {
1311 return new Status(StatusCode.SUCCESS);
1313 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1314 propMap.remove(propName);
1315 if (nodeProps.replace(node, propMapCurr, propMap)) {
1316 return new Status(StatusCode.SUCCESS);
1319 return new Status(StatusCode.SUCCESS);
1322 String msg = "Cluster conflict: Unable to remove property " + propName + " for node " + node.getID();
1323 return new Status(StatusCode.CONFLICT, msg);
1327 public Status removeNodeAllProps(Node node) {
1328 this.nodeProps.remove(node);
1329 return new Status(StatusCode.SUCCESS);
1333 public Set<NodeConnector> getUpNodeConnectors(Node node) {
1334 if (nodeConnectorProps == null) {
1338 Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1339 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1340 NodeConnector nodeConnector = entry.getKey();
1341 if (!nodeConnector.getNode().equals(node)) {
1344 if (isNodeConnectorEnabled(nodeConnector)) {
1345 nodeConnectorSet.add(nodeConnector);
1349 return nodeConnectorSet;
1353 public Set<NodeConnector> getNodeConnectors(Node node) {
1354 if (nodeConnectorProps == null) {
1358 Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1359 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1360 NodeConnector nodeConnector = entry.getKey();
1361 if (!nodeConnector.getNode().equals(node)) {
1364 nodeConnectorSet.add(nodeConnector);
1367 return nodeConnectorSet;
1371 public Set<NodeConnector> getPhysicalNodeConnectors(Node node) {
1372 if (nodeConnectorProps == null) {
1376 Set<NodeConnector> nodeConnectorSet = new HashSet<NodeConnector>();
1377 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1378 NodeConnector nodeConnector = entry.getKey();
1379 if (!nodeConnector.getNode().equals(node)
1380 || isSpecial(nodeConnector)) {
1383 nodeConnectorSet.add(nodeConnector);
1386 return nodeConnectorSet;
1390 public Map<String, Property> getNodeConnectorProps(NodeConnector nodeConnector) {
1391 Map<String, Property> rv = new HashMap<String, Property>();
1392 if (this.nodeConnectorProps != null) {
1393 rv = this.nodeConnectorProps.get(nodeConnector);
1395 rv = new HashMap<String, Property>(rv);
1402 public Property getNodeConnectorProp(NodeConnector nodeConnector,
1404 Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1405 return (propMap != null) ? propMap.get(propName) : null;
1409 public byte[] getControllerMAC() {
1410 MacAddress macProperty = (MacAddress)controllerProps.get(MacAddress.name);
1411 return (macProperty == null) ? null : macProperty.getMacAddress();
1415 public NodeConnector getNodeConnector(Node node, String nodeConnectorName) {
1416 if (nodeConnectorNames == null) {
1420 Map<String, NodeConnector> map = nodeConnectorNames.get(node);
1425 return map.get(nodeConnectorName);
1429 * Adds a node connector and its property if any
1431 * @param nodeConnector
1432 * {@link org.opendaylight.controller.sal.core.NodeConnector}
1434 * name of {@link org.opendaylight.controller.sal.core.Property}
1435 * @return success or failed reason
1438 public Status addNodeConnectorProp(NodeConnector nodeConnector,
1440 Map<String, Property> propMapCurr = getNodeConnectorProps(nodeConnector);
1441 Map<String, Property> propMap = (propMapCurr == null) ? new HashMap<String, Property>()
1442 : new HashMap<String, Property>(propMapCurr);
1444 String msg = "Cluster conflict: Unable to add NodeConnector Property.";
1445 // Just add the nodeConnector if prop is not available (in a non-default
1448 if (propMapCurr == null) {
1449 if (nodeConnectorProps.putIfAbsent(nodeConnector, propMap) != null) {
1450 return new Status(StatusCode.CONFLICT, msg);
1453 if (!nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap)) {
1454 return new Status(StatusCode.CONFLICT, msg);
1457 return new Status(StatusCode.SUCCESS);
1460 propMap.put(prop.getName(), prop);
1461 if (propMapCurr == null) {
1462 if (nodeConnectorProps.putIfAbsent(nodeConnector, propMap) != null) {
1463 return new Status(StatusCode.CONFLICT, msg);
1466 if (!nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap)) {
1467 return new Status(StatusCode.CONFLICT, msg);
1471 if (prop.getName().equals(Name.NamePropName)) {
1472 if (nodeConnectorNames != null) {
1473 Node node = nodeConnector.getNode();
1474 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1475 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1476 if (mapCurr != null) {
1477 for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1478 String s = entry.getKey();
1480 map.put(s, new NodeConnector(entry.getValue()));
1481 } catch (ConstructionException e) {
1482 log.error("An error occured",e);
1487 map.put(((Name) prop).getValue(), nodeConnector);
1488 if (mapCurr == null) {
1489 if (nodeConnectorNames.putIfAbsent(node, map) != null) {
1490 // TODO: recovery using Transactionality
1491 return new Status(StatusCode.CONFLICT, msg);
1494 if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1495 // TODO: recovery using Transactionality
1496 return new Status(StatusCode.CONFLICT, msg);
1502 return new Status(StatusCode.SUCCESS);
1506 * Removes one property of a node connector
1508 * @param nodeConnector
1509 * {@link org.opendaylight.controller.sal.core.NodeConnector}
1511 * name of {@link org.opendaylight.controller.sal.core.Property}
1512 * @return success or failed reason
1515 public Status removeNodeConnectorProp(NodeConnector nodeConnector, String propName) {
1516 Map<String, Property> propMapCurr = getNodeConnectorProps(nodeConnector);
1518 if (propMapCurr == null) {
1519 /* Nothing to remove */
1520 return new Status(StatusCode.SUCCESS);
1523 Map<String, Property> propMap = new HashMap<String, Property>(propMapCurr);
1524 propMap.remove(propName);
1525 boolean result = nodeConnectorProps.replace(nodeConnector, propMapCurr, propMap);
1526 String msg = "Cluster conflict: Unable to remove NodeConnector property.";
1528 return new Status(StatusCode.CONFLICT, msg);
1531 if (propName.equals(Name.NamePropName)) {
1532 if (nodeConnectorNames != null) {
1533 Name name = ((Name) getNodeConnectorProp(nodeConnector, Name.NamePropName));
1535 Node node = nodeConnector.getNode();
1536 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1537 if (mapCurr != null) {
1538 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1539 for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1540 String s = entry.getKey();
1542 map.put(s, new NodeConnector(entry.getValue()));
1543 } catch (ConstructionException e) {
1544 log.error("An error occured",e);
1547 map.remove(name.getValue());
1548 if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1549 // TODO: recovery using Transactionality
1550 return new Status(StatusCode.CONFLICT, msg);
1557 return new Status(StatusCode.SUCCESS);
1561 * Removes all the properties of a node connector
1563 * @param nodeConnector
1564 * {@link org.opendaylight.controller.sal.core.NodeConnector}
1565 * @return success or failed reason
1568 public Status removeNodeConnectorAllProps(NodeConnector nodeConnector) {
1569 if (nodeConnectorNames != null) {
1570 Name name = ((Name) getNodeConnectorProp(nodeConnector, Name.NamePropName));
1572 Node node = nodeConnector.getNode();
1573 Map<String, NodeConnector> mapCurr = nodeConnectorNames.get(node);
1574 if (mapCurr != null) {
1575 Map<String, NodeConnector> map = new HashMap<String, NodeConnector>();
1576 for (Map.Entry<String, NodeConnector> entry : mapCurr.entrySet()) {
1577 String s = entry.getKey();
1579 map.put(s, new NodeConnector(entry.getValue()));
1580 } catch (ConstructionException e) {
1581 log.error("An error occured",e);
1584 map.remove(name.getValue());
1585 if (map.isEmpty()) {
1586 nodeConnectorNames.remove(node);
1588 if (!nodeConnectorNames.replace(node, mapCurr, map)) {
1589 log.warn("Cluster conflict: Unable remove Name property of nodeconnector {}, skip.",
1590 nodeConnector.getID());
1597 nodeConnectorProps.remove(nodeConnector);
1599 return new Status(StatusCode.SUCCESS);
1603 * Function called by the dependency manager when all the required
1604 * dependencies are satisfied
1607 void init(Component c) {
1608 Dictionary<?, ?> props = c.getServiceProperties();
1609 if (props != null) {
1610 this.containerName = (String) props.get("containerName");
1611 log.trace("Running containerName: {}", this.containerName);
1613 // In the Global instance case the containerName is empty
1614 this.containerName = "";
1616 isDefaultContainer = containerName.equals(GlobalConstants.DEFAULT
1622 * Function called by the dependency manager when at least one dependency
1623 * become unsatisfied or when the component is shutting down because for
1624 * example bundle is being stopped.
1632 * Function called by dependency manager after "init ()" is called and after
1633 * the services provided by the class are registered in the service registry
1640 * Read startup and build database if we are the coordinator
1642 loadSubnetConfiguration();
1643 loadSpanConfiguration();
1644 loadSwitchConfiguration();
1647 registerWithOSGIConsole();
1651 * Function called after registered the service in OSGi service registry.
1654 // solicit for existing inventories
1659 * Function called by the dependency manager before the services exported by
1660 * the component are unregistered, this will be followed by a "destroy ()"
1667 public void setConfigurationContainerService(IConfigurationContainerService service) {
1668 log.trace("Got configuration service set request {}", service);
1669 this.configurationService = service;
1672 public void unsetConfigurationContainerService(IConfigurationContainerService service) {
1673 log.trace("Got configuration service UNset request");
1674 this.configurationService = null;
1677 public void setInventoryService(IInventoryService service) {
1678 log.trace("Got inventory service set request {}", service);
1679 this.inventoryService = service;
1681 // solicit for existing inventories
1685 public void unsetInventoryService(IInventoryService service) {
1686 log.trace("Got a service UNset request");
1687 this.inventoryService = null;
1689 // clear existing inventories
1693 public void setStatisticsManager(IStatisticsManager statisticsManager) {
1694 log.trace("Got statistics manager set request {}", statisticsManager);
1695 this.statisticsManager = statisticsManager;
1698 public void unsetStatisticsManager(IStatisticsManager statisticsManager) {
1699 log.trace("Got statistics manager UNset request");
1700 this.statisticsManager = null;
1703 public void setSwitchManagerAware(ISwitchManagerAware service) {
1704 log.trace("Got inventory service set request {}", service);
1705 if (this.switchManagerAware != null) {
1706 this.switchManagerAware.add(service);
1709 // bulk update for newly joined
1710 switchManagerAwareNotify(service);
1713 public void unsetSwitchManagerAware(ISwitchManagerAware service) {
1714 log.trace("Got a service UNset request");
1715 if (this.switchManagerAware != null) {
1716 this.switchManagerAware.remove(service);
1720 public void setInventoryListener(IInventoryListener service) {
1721 log.trace("Got inventory listener set request {}", service);
1722 if (this.inventoryListeners != null) {
1723 this.inventoryListeners.add(service);
1726 // bulk update for newly joined
1727 bulkUpdateService(service);
1730 public void unsetInventoryListener(IInventoryListener service) {
1731 log.trace("Got a service UNset request");
1732 if (this.inventoryListeners != null) {
1733 this.inventoryListeners.remove(service);
1737 public void setSpanAware(ISpanAware service) {
1738 log.trace("Got SpanAware set request {}", service);
1739 if (this.spanAware != null) {
1740 this.spanAware.add(service);
1743 // bulk update for newly joined
1744 spanAwareNotify(service);
1747 public void unsetSpanAware(ISpanAware service) {
1748 log.trace("Got a service UNset request");
1749 if (this.spanAware != null) {
1750 this.spanAware.remove(service);
1754 void setClusterContainerService(IClusterContainerServices s) {
1755 log.trace("Cluster Service set");
1756 this.clusterContainerService = s;
1759 void unsetClusterContainerService(IClusterContainerServices s) {
1760 if (this.clusterContainerService == s) {
1761 log.trace("Cluster Service removed!");
1762 this.clusterContainerService = null;
1766 public void setControllerProperties(IControllerProperties controllerProperties) {
1767 log.trace("Got controller properties set request {}", controllerProperties);
1768 this.controllerProperties = controllerProperties;
1771 public void unsetControllerProperties(IControllerProperties controllerProperties) {
1772 log.trace("Got controller properties UNset request");
1773 this.controllerProperties = null;
1776 private void getInventories() {
1777 if (inventoryService == null) {
1778 log.trace("inventory service not avaiable");
1782 Map<Node, Map<String, Property>> nodeProp = this.inventoryService.getNodeProps();
1783 for (Map.Entry<Node, Map<String, Property>> entry : nodeProp.entrySet()) {
1784 Node node = entry.getKey();
1785 log.debug("getInventories: {} added for container {}", new Object[] { node, containerName });
1786 Map<String, Property> propMap = entry.getValue();
1787 Set<Property> props = new HashSet<Property>();
1788 for (Property property : propMap.values()) {
1789 props.add(property);
1791 addNode(node, props);
1794 Map<NodeConnector, Map<String, Property>> nodeConnectorProp = this.inventoryService.getNodeConnectorProps();
1795 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProp.entrySet()) {
1796 Map<String, Property> propMap = entry.getValue();
1797 for (Property property : propMap.values()) {
1798 addNodeConnectorProp(entry.getKey(), property);
1803 private void clearInventories() {
1805 nodeConnectorProps.clear();
1806 nodeConnectorNames.clear();
1807 spanNodeConnectors.clear();
1810 private void notifyNode(Node node, UpdateType type,
1811 Map<String, Property> propMap) {
1812 synchronized (inventoryListeners) {
1813 for (IInventoryListener service : inventoryListeners) {
1814 service.notifyNode(node, type, propMap);
1819 private void notifyNodeConnector(NodeConnector nodeConnector,
1820 UpdateType type, Map<String, Property> propMap) {
1821 synchronized (inventoryListeners) {
1822 for (IInventoryListener service : inventoryListeners) {
1823 service.notifyNodeConnector(nodeConnector, type, propMap);
1829 * For those joined late, bring them up-to-date.
1831 private void switchManagerAwareNotify(ISwitchManagerAware service) {
1832 for (Subnet sub : subnets.values()) {
1833 service.subnetNotify(sub, true);
1836 for (Node node : getNodes()) {
1837 SwitchConfig sc = getSwitchConfig(node.toString());
1838 if ((sc != null) && isDefaultContainer) {
1839 ForwardingMode mode = (ForwardingMode) sc.getProperty(ForwardingMode.name);
1840 service.modeChangeNotify(node, (mode == null) ? false : mode.isProactive());
1845 private void bulkUpdateService(IInventoryListener service) {
1846 Map<String, Property> propMap;
1847 UpdateType type = UpdateType.ADDED;
1849 for (Node node : getNodes()) {
1850 propMap = nodeProps.get(node);
1851 service.notifyNode(node, type, propMap);
1854 for (Map.Entry<NodeConnector, Map<String, Property>> entry : nodeConnectorProps.entrySet()) {
1855 NodeConnector nodeConnector = entry.getKey();
1856 propMap = nodeConnectorProps.get(nodeConnector);
1857 service.notifyNodeConnector(nodeConnector, type, propMap);
1861 private void spanAwareNotify(ISpanAware service) {
1862 for (Node node : getNodes()) {
1863 for (SpanConfig conf : getSpanConfigList(node)) {
1864 service.spanUpdate(node, conf.getPortArrayList(), true);
1869 private void registerWithOSGIConsole() {
1870 BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass())
1871 .getBundleContext();
1872 bundleContext.registerService(CommandProvider.class.getName(), this,
1877 public Boolean isNodeConnectorEnabled(NodeConnector nodeConnector) {
1878 if (nodeConnector == null) {
1882 Config config = (Config) getNodeConnectorProp(nodeConnector,
1883 Config.ConfigPropName);
1884 State state = (State) getNodeConnectorProp(nodeConnector,
1885 State.StatePropName);
1886 return ((config != null) && (config.getValue() == Config.ADMIN_UP)
1887 && (state != null) && (state.getValue() == State.EDGE_UP));
1891 public boolean doesNodeConnectorExist(NodeConnector nc) {
1892 return (nc != null && nodeConnectorProps != null
1893 && nodeConnectorProps.containsKey(nc));
1897 public String getHelp() {
1898 StringBuffer help = new StringBuffer();
1899 help.append("---Switch Manager---\n");
1900 help.append("\t pencs <node id> - Print enabled node connectors for a given node\n");
1901 help.append("\t pdm <node id> - Print switch ports in device map\n");
1902 return help.toString();
1905 public void _pencs(CommandInterpreter ci) {
1906 String st = ci.nextArgument();
1908 ci.println("Please enter node id");
1912 Node node = Node.fromString(st);
1914 ci.println("Please enter node id");
1918 Set<NodeConnector> nodeConnectorSet = getUpNodeConnectors(node);
1919 if (nodeConnectorSet == null) {
1922 for (NodeConnector nodeConnector : nodeConnectorSet) {
1923 if (nodeConnector == null) {
1926 ci.println(nodeConnector);
1928 ci.println("Total number of NodeConnectors: " + nodeConnectorSet.size());
1931 public void _pdm(CommandInterpreter ci) {
1932 String st = ci.nextArgument();
1934 ci.println("Please enter node id");
1938 Node node = Node.fromString(st);
1940 ci.println("Please enter node id");
1944 Switch sw = getSwitchByNode(node);
1946 ci.println(" NodeConnector Name");
1948 Set<NodeConnector> nodeConnectorSet = sw.getNodeConnectors();
1949 String nodeConnectorName;
1950 if (nodeConnectorSet != null && nodeConnectorSet.size() > 0) {
1951 for (NodeConnector nodeConnector : nodeConnectorSet) {
1952 Map<String, Property> propMap = getNodeConnectorProps(nodeConnector);
1953 nodeConnectorName = (propMap == null) ? null : ((Name) propMap
1954 .get(Name.NamePropName)).getValue();
1955 if (nodeConnectorName != null) {
1956 Node nd = nodeConnector.getNode();
1957 if (!nd.equals(node)) {
1958 log.debug("node not match {} {}", nd, node);
1960 Map<String, NodeConnector> map = nodeConnectorNames
1963 NodeConnector nc = map.get(nodeConnectorName);
1965 log.debug("no nodeConnector named {}",
1967 } else if (!nc.equals(nodeConnector)) {
1968 log.debug("nodeConnector not match {} {}", nc,
1974 ci.println(nodeConnector
1976 + ((nodeConnectorName == null) ? "" : nodeConnectorName)
1977 + "(" + nodeConnector.getID() + ")");
1979 ci.println("Total number of NodeConnectors: "
1980 + nodeConnectorSet.size());
1985 public byte[] getNodeMAC(Node node) {
1986 MacAddress mac = (MacAddress) this.getNodeProp(node,
1988 return (mac != null) ? mac.getMacAddress() : null;
1992 public boolean isSpecial(NodeConnector p) {
1993 if (p.getType().equals(NodeConnectorIDType.CONTROLLER)
1994 || p.getType().equals(NodeConnectorIDType.ALL)
1995 || p.getType().equals(NodeConnectorIDType.SWSTACK)
1996 || p.getType().equals(NodeConnectorIDType.HWPATH)) {
2003 * Add span configuration to local cache and notify clients
2005 private void addSpanPorts(Node node, List<NodeConnector> nodeConnectors) {
2006 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2008 for (NodeConnector nodeConnector : nodeConnectors) {
2009 if (!spanNodeConnectors.contains(nodeConnector)) {
2010 ncLists.add(nodeConnector);
2014 if (ncLists.size() > 0) {
2015 spanNodeConnectors.addAll(ncLists);
2016 notifySpanPortChange(node, ncLists, true);
2020 private void addSpanPorts(Node node) {
2021 for (SpanConfig conf : getSpanConfigList(node)) {
2022 addSpanPorts(node, conf.getPortArrayList());
2026 private void addSpanPort(NodeConnector nodeConnector) {
2027 // only add if span is configured on this nodeConnector
2028 for (SpanConfig conf : getSpanConfigList(nodeConnector.getNode())) {
2029 if (conf.getPortArrayList().contains(nodeConnector)) {
2030 List<NodeConnector> ncList = new ArrayList<NodeConnector>();
2031 ncList.add(nodeConnector);
2032 addSpanPorts(nodeConnector.getNode(), ncList);
2039 * Remove span configuration to local cache and notify clients
2041 private void removeSpanPorts(Node node, List<NodeConnector> nodeConnectors) {
2042 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2044 for (NodeConnector nodeConnector : nodeConnectors) {
2045 if (spanNodeConnectors.contains(nodeConnector)) {
2046 ncLists.add(nodeConnector);
2050 if (ncLists.size() > 0) {
2051 spanNodeConnectors.removeAll(ncLists);
2052 notifySpanPortChange(node, ncLists, false);
2056 private void removeSpanPorts(Node node) {
2057 for (SpanConfig conf : getSpanConfigList(node)) {
2058 addSpanPorts(node, conf.getPortArrayList());
2062 private void removeSpanPort(NodeConnector nodeConnector) {
2063 if (spanNodeConnectors.contains(nodeConnector)) {
2064 List<NodeConnector> ncLists = new ArrayList<NodeConnector>();
2065 ncLists.add(nodeConnector);
2066 removeSpanPorts(nodeConnector.getNode(), ncLists);
2070 private void addNodeProps(Node node, Map<String, Property> propMap) {
2071 if (propMap == null) {
2072 propMap = new HashMap<String, Property>();
2074 nodeProps.put(node, propMap);
2078 public Status saveConfiguration() {
2079 return saveSwitchConfig();
2083 * Creates a Name/Tier/Bandwidth/MacAddress(controller property) Property
2084 * object based on given property name and value. Other property types are
2085 * not supported yet.
2088 * Name of the Property
2090 * Value of the Property
2091 * @return {@link org.opendaylight.controller.sal.core.Property}
2094 public Property createProperty(String propName, String propValue) {
2095 if (propName == null) {
2096 log.debug("propName is null");
2099 if (propValue == null) {
2100 log.debug("propValue is null");
2105 if (propName.equalsIgnoreCase(Description.propertyName)) {
2106 return new Description(propValue);
2107 } else if (propName.equalsIgnoreCase(Tier.TierPropName)) {
2108 int tier = Integer.parseInt(propValue);
2109 return new Tier(tier);
2110 } else if (propName.equalsIgnoreCase(Bandwidth.BandwidthPropName)) {
2111 long bw = Long.parseLong(propValue);
2112 return new Bandwidth(bw);
2113 } else if (propName.equalsIgnoreCase(ForwardingMode.name)) {
2114 int mode = Integer.parseInt(propValue);
2115 return new ForwardingMode(mode);
2116 } else if (propName.equalsIgnoreCase(MacAddress.name)){
2117 return new MacAddress(propValue);
2120 log.debug("Not able to create {} property", propName);
2122 } catch (Exception e) {
2123 log.debug("createProperty caught exception {}", e.getMessage());
2130 @SuppressWarnings("deprecation")
2132 public String getNodeDescription(Node node) {
2133 // Check first if user configured a name
2134 SwitchConfig config = getSwitchConfig(node.toString());
2135 if (config != null) {
2136 String configuredDesc = config.getNodeDescription();
2137 if (configuredDesc != null && !configuredDesc.isEmpty()) {
2138 return configuredDesc;
2142 // No name configured by user, get the node advertised name
2143 Description desc = (Description) getNodeProp(node,
2144 Description.propertyName);
2145 return (desc == null /* || desc.getValue().equalsIgnoreCase("none") */) ? ""
2150 public Set<Switch> getConfiguredNotConnectedSwitches() {
2151 Set<Switch> configuredNotConnectedSwitches = new HashSet<Switch>();
2152 if (this.inventoryService == null) {
2153 log.trace("inventory service not available");
2154 return configuredNotConnectedSwitches;
2157 Set<Node> configuredNotConnectedNodes = this.inventoryService.getConfiguredNotConnectedNodes();
2158 if (configuredNotConnectedNodes != null) {
2159 for (Node node : configuredNotConnectedNodes) {
2160 Switch sw = getSwitchByNode(node);
2161 configuredNotConnectedSwitches.add(sw);
2164 return configuredNotConnectedSwitches;