2 * Copyright (c) 2014 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
8 package org.opendaylight.controller.sal.compatibility;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.Objects;
12 import com.google.common.base.Preconditions;
13 import java.math.BigInteger;
14 import java.util.Date;
15 import java.util.HashSet;
16 import java.util.List;
17 import java.util.regex.Pattern;
18 import org.opendaylight.controller.sal.common.util.Arguments;
19 import org.opendaylight.controller.sal.core.AdvertisedBandwidth;
20 import org.opendaylight.controller.sal.core.Bandwidth;
21 import org.opendaylight.controller.sal.core.Buffers;
22 import org.opendaylight.controller.sal.core.Capabilities;
23 import org.opendaylight.controller.sal.core.Config;
24 import org.opendaylight.controller.sal.core.ConstructionException;
25 import org.opendaylight.controller.sal.core.Description;
26 import org.opendaylight.controller.sal.core.MacAddress;
27 import org.opendaylight.controller.sal.core.Name;
28 import org.opendaylight.controller.sal.core.Node.NodeIDType;
29 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
30 import org.opendaylight.controller.sal.core.PeerBandwidth;
31 import org.opendaylight.controller.sal.core.Property;
32 import org.opendaylight.controller.sal.core.SupportedBandwidth;
33 import org.opendaylight.controller.sal.core.Tables;
34 import org.opendaylight.controller.sal.core.TimeStamp;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FeatureCapability;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnectorUpdated;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdated;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityArpMatchIp;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityFlowStats;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityIpReasm;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityPortStats;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityQueueStats;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityStp;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityTableStats;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowNode;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowNodeConnector;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeatures;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortConfig;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.flow.capable.port.State;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.OutputPortValues;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorUpdated;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
68 public final class NodeMapping {
70 private static final Logger LOG = LoggerFactory
71 .getLogger(NodeMapping.class);
76 public static final String OPENFLOW_ID_PREFIX = "openflow:";
78 public final static String MD_SAL_TYPE = "MD_SAL_DEPRECATED";
80 private final static Class<Node> NODE_CLASS = Node.class;
82 private final static Class<NodeConnector> NODECONNECTOR_CLASS = NodeConnector.class;
84 private final static Pattern COLON_NUMBERS_EOL = Pattern.compile(":[0-9]+$");
86 private final static Pattern NUMBERS_ONLY = Pattern.compile("[0-9]+");
88 private final static Pattern ALL_CHARS_TO_COLON = Pattern.compile("^.*:");
90 private NodeMapping() {
91 throw new UnsupportedOperationException("Utility class. Instantiation is not allowed.");
94 public static org.opendaylight.controller.sal.core.Node toADNode(final InstanceIdentifier<? extends Object> node) throws ConstructionException {
95 NodeId nodeId = NodeMapping.toNodeId(node);
96 return NodeMapping.toADNode(nodeId);
99 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeId id) throws ConstructionException {
100 String nodeId = NodeMapping.toADNodeId(id);
101 String nodeIdasNumber = nodeId.replaceFirst("^.*:", "");
102 if (isInteger(nodeIdasNumber)) {
103 Long aDNodeId = openflowFullNodeIdToLong(nodeIdasNumber);
104 return new org.opendaylight.controller.sal.core.Node(NodeIDType.OPENFLOW, aDNodeId);
106 return new org.opendaylight.controller.sal.core.Node(NodeIDType.PRODUCTION, nodeId);
112 * @return nodeId as long
115 public static Long openflowFullNodeIdToLong(String adNodeId) {
116 if (adNodeId == null) {
119 return new BigInteger(adNodeId).longValue();
122 public static NodeId toNodeId(final InstanceIdentifier<?> id) {
123 final NodeKey key = id.firstKeyOf(Node.class, NodeKey.class);
124 Preconditions.checkArgument(key != null, "No node identifier found in %s", id);
129 * @param nodeId containing "<NodeTypeString>:<plainIntegerId>"
130 * @return adNodeId form
132 public static String toADNodeId(final NodeId nodeId) {
133 if (nodeId == null) {
136 return nodeId.getValue();
139 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorRef source) throws ConstructionException {
140 final InstanceIdentifier<?> id = Preconditions.checkNotNull(source.getValue());
141 final NodeConnectorKey key = id.firstKeyOf(NodeConnector.class, NodeConnectorKey.class);
142 return NodeMapping.toADNodeConnector(key.getId(), NodeMapping.toNodeId(id));
145 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorId ncid, final NodeId nid) throws ConstructionException {
146 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
147 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
148 org.opendaylight.controller.sal.core.Node aDNode = NodeMapping.toADNode(nid);
149 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
153 * @param ncid nodeConnector identifier, e.g.: OF:21 or CTRL
155 * @return nodeConnector attached to given node
156 * @throws ConstructionException
158 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(
159 final NodeConnectorId ncid, final org.opendaylight.controller.sal.core.Node aDNode) throws ConstructionException {
160 NodeId nid = NodeMapping.toNodeId(aDNode);
161 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
162 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
163 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
170 private static NodeId toNodeId(org.opendaylight.controller.sal.core.Node aDNode) {
171 return new NodeId(aDNode.getType() + ":" + String.valueOf(aDNode.getID()));
174 public static String toNodeConnectorType(final NodeConnectorId ncId, final NodeId nodeId) {
175 if (ncId.equals(toLocalNodeConnectorId(nodeId))) {
176 return NodeConnectorIDType.SWSTACK;
177 } else if (ncId.equals(toNormalNodeConnectorId(nodeId))) {
178 return NodeConnectorIDType.HWPATH;
179 } else if (ncId.equals(toControllerNodeConnectorId(nodeId))) {
180 return NodeConnectorIDType.CONTROLLER;
182 return NodeConnectorIDType.OPENFLOW;
185 public static Object toADNodeConnectorId(final NodeConnectorId nodeConnectorId, final NodeId nodeId) {
186 if (nodeConnectorId.equals(toLocalNodeConnectorId(nodeId)) ||
187 nodeConnectorId.equals(toNormalNodeConnectorId(nodeId)) ||
188 nodeConnectorId.equals(toControllerNodeConnectorId(nodeId))) {
189 return org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID;
192 String nodeConnectorIdStripped = ALL_CHARS_TO_COLON.matcher(nodeConnectorId.getValue()).replaceFirst("");
194 if (NUMBERS_ONLY.matcher(nodeConnectorIdStripped).matches()) {
195 Short nodeConnectorIdVal = null;
197 nodeConnectorIdVal = Short.valueOf(nodeConnectorIdStripped);
198 return nodeConnectorIdVal;
199 } catch (NumberFormatException e) {
200 LOG.warn("nodeConnectorId not supported (long): {}", nodeConnectorIdStripped, e);
203 return nodeConnectorIdStripped;
206 public static NodeId toAdNodeId(final NodeConnectorId nodeConnectorId) {
207 NodeId nodeId = null;
208 if (nodeConnectorId != null) {
209 nodeId = new NodeId(COLON_NUMBERS_EOL.matcher(nodeConnectorId.getValue()).replaceFirst(""));
214 public static NodeConnectorId toControllerNodeConnectorId(final NodeId node) {
215 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.CONTROLLER.toString());
218 public static NodeConnectorId toLocalNodeConnectorId(final NodeId node) {
219 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.LOCAL.toString());
222 public static NodeConnectorId toNormalNodeConnectorId(final NodeId node) {
223 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.NORMAL.toString());
226 public static NodeRef toNodeRef(final org.opendaylight.controller.sal.core.Node node) {
227 Preconditions.checkArgument(NodeIDType.OPENFLOW.equals(node.getType()));
228 final Long nodeId = Arguments.<Long>checkInstanceOf(node.getID(), Long.class);
229 final NodeKey nodeKey = new NodeKey(new NodeId(OPENFLOW_ID_PREFIX + nodeId));
230 final InstanceIdentifier<Node> nodePath = InstanceIdentifier.builder(Nodes.class).child(NODE_CLASS, nodeKey).toInstance();
231 return new NodeRef(nodePath);
234 public static NodeConnectorRef toNodeConnectorRef(final org.opendaylight.controller.sal.core.NodeConnector nodeConnector) {
236 final NodeRef node = NodeMapping.toNodeRef(nodeConnector.getNode());
237 @SuppressWarnings("unchecked")
238 final InstanceIdentifier<Node> nodePath = ((InstanceIdentifier<Node>) node.getValue());
239 NodeConnectorId nodeConnectorId = null;
241 if (nodeConnector.getID().equals(org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID)) {
242 final NodeId nodeId = toNodeId(nodePath);
243 final String nodeConnectorType = nodeConnector.getType();
244 if (nodeConnectorType.equals(NodeConnectorIDType.SWSTACK)) {
245 nodeConnectorId = toLocalNodeConnectorId(nodeId);
246 } else if (nodeConnectorType.equals(NodeConnectorIDType.HWPATH)) {
247 nodeConnectorId = toNormalNodeConnectorId(nodeId);
248 } else if (nodeConnectorType.equals(NodeConnectorIDType.CONTROLLER)) {
249 nodeConnectorId = toControllerNodeConnectorId(nodeId);
252 nodeConnectorId = new NodeConnectorId(OPENFLOW_ID_PREFIX
253 + Arguments.<Short>checkInstanceOf(nodeConnector.getID(), Short.class));
255 final NodeConnectorKey connectorKey = new NodeConnectorKey(nodeConnectorId);
256 final InstanceIdentifier<NodeConnector> path = nodePath.child(NODECONNECTOR_CLASS, connectorKey);
257 return new NodeConnectorRef(path);
260 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeRef node) throws ConstructionException {
261 return NodeMapping.toADNode(node.getValue());
264 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnectorUpdated nc) {
265 final FlowCapableNodeConnectorUpdated fcncu = nc.<FlowCapableNodeConnectorUpdated>getAugmentation(FlowCapableNodeConnectorUpdated.class);
266 if (!Objects.equal(fcncu, null)) {
267 HashSet<Property> adNodeConnectorProperties = NodeMapping.toADNodeConnectorProperties(fcncu);
268 return adNodeConnectorProperties;
270 return new HashSet<Property>();
275 * @return node description in AD form, e.g.: OF|00:00:00:...:01
277 private static Description toADDescription(NodeRef nodeRef) {
280 desc = new Description(toADNode(nodeRef).toString());
281 } catch (ConstructionException e) {
282 desc = new Description("none");
283 LOG.warn("node description extraction failed: {}", nodeRef);
288 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnector nc) {
289 final FlowCapableNodeConnector fcnc = nc.<FlowCapableNodeConnector>getAugmentation(FlowCapableNodeConnector.class);
290 if (!Objects.equal(fcnc, null)) {
291 return NodeMapping.toADNodeConnectorProperties(fcnc);
293 return new HashSet<Property>();
296 public static HashSet<Property> toADNodeConnectorProperties(final FlowNodeConnector fcncu) {
298 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
300 if (fcncu.getCurrentFeature() != null && toAdBandwidth(fcncu.getCurrentFeature()) != null) {
301 props.add(toAdBandwidth(fcncu.getCurrentFeature()));
303 if (fcncu.getAdvertisedFeatures() != null && toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()) != null) {
304 props.add(toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()));
306 if (fcncu.getSupported() != null && toAdSupportedBandwidth(fcncu.getSupported()) != null) {
307 props.add(toAdSupportedBandwidth(fcncu.getSupported()));
309 if (fcncu.getPeerFeatures() != null && toAdPeerBandwidth(fcncu.getPeerFeatures()) != null) {
310 props.add(toAdPeerBandwidth(fcncu.getPeerFeatures()));
312 if (fcncu.getName() != null && toAdName(fcncu.getName()) != null) {
313 props.add(toAdName(fcncu.getName()));
315 if (fcncu.getConfiguration() != null && toAdConfig(fcncu.getConfiguration()) != null) {
316 props.add(toAdConfig(fcncu.getConfiguration()));
318 if (fcncu.getState() != null && toAdState(fcncu.getState()) != null) {
319 props.add(toAdState(fcncu.getState()));
325 public static Name toAdName(final String name) {
326 return new Name(name);
329 public static Config toAdConfig(final PortConfig pc) {
330 Config config = null;
331 if (pc.isPORTDOWN()) {
332 config = new Config(Config.ADMIN_DOWN);
334 config = new Config(Config.ADMIN_UP);
339 public static org.opendaylight.controller.sal.core.State toAdState(final State s) {
341 org.opendaylight.controller.sal.core.State state = null;
342 if (s.isLinkDown()) {
343 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_DOWN);
345 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_UP);
350 public static Bandwidth toAdBandwidth(final PortFeatures pf) {
352 if (pf.isTenMbHd() || pf.isTenMbFd()) {
353 bw = new Bandwidth(Bandwidth.BW10Mbps);
354 } else if (pf.isHundredMbHd() || pf.isHundredMbFd()) {
355 bw = new Bandwidth(Bandwidth.BW100Mbps);
356 } else if (pf.isOneGbHd() || pf.isOneGbFd()) {
357 bw = new Bandwidth(Bandwidth.BW1Gbps);
358 } else if (pf.isOneGbFd()) {
359 bw = new Bandwidth(Bandwidth.BW10Gbps);
360 } else if (pf.isTenGbFd()) {
361 bw = new Bandwidth(Bandwidth.BW10Gbps);
362 } else if (pf.isFortyGbFd()) {
363 bw = new Bandwidth(Bandwidth.BW40Gbps);
364 } else if (pf.isHundredGbFd()) {
365 bw = new Bandwidth(Bandwidth.BW100Gbps);
366 } else if (pf.isOneTbFd()) {
367 bw = new Bandwidth(Bandwidth.BW1Tbps);
372 public static AdvertisedBandwidth toAdAdvertizedBandwidth(final PortFeatures pf) {
373 AdvertisedBandwidth abw = null;
374 final Bandwidth bw = toAdBandwidth(pf);
376 abw = new AdvertisedBandwidth(bw.getValue());
381 public static SupportedBandwidth toAdSupportedBandwidth(final PortFeatures pf) {
382 SupportedBandwidth sbw = null;
383 final Bandwidth bw = toAdBandwidth(pf);
385 sbw = new SupportedBandwidth(bw.getValue());
390 public static PeerBandwidth toAdPeerBandwidth(final PortFeatures pf) {
391 PeerBandwidth pbw = null;
392 final Bandwidth bw = toAdBandwidth(pf);
394 pbw = new PeerBandwidth(bw.getValue());
399 public static HashSet<Property> toADNodeProperties(final NodeUpdated nu) {
400 final FlowCapableNodeUpdated fcnu = nu.getAugmentation(FlowCapableNodeUpdated.class);
402 HashSet<Property> adNodeProperties = toADNodeProperties(fcnu, nu.getId());
403 adNodeProperties.add(toADDescription(nu.getNodeRef()));
404 return adNodeProperties;
406 return new HashSet<org.opendaylight.controller.sal.core.Property>();
409 public static HashSet<Property> toADNodeProperties(final FlowNode fcnu, final NodeId id) {
411 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
414 props.add(toADTimestamp());
416 // props.add(fcnu.supportedActions.toADActions) - TODO
418 props.add(toADMacAddress(id));
420 SwitchFeatures switchFeatures = fcnu.getSwitchFeatures();
421 if (switchFeatures != null) {
422 if (switchFeatures.getMaxTables() != null) {
423 props.add(toADTables(switchFeatures.getMaxTables()));
425 if (switchFeatures.getCapabilities() != null) {
426 props.add(toADCapabiliities(switchFeatures.getCapabilities()));
428 if (switchFeatures.getMaxBuffers() != null) {
429 props.add(toADBuffers(switchFeatures.getMaxBuffers()));
436 public static TimeStamp toADTimestamp() {
437 final Date date = new Date();
438 final TimeStamp timestamp = new TimeStamp(date.getTime(), "connectedSince");
442 public static MacAddress toADMacAddress(final NodeId id) {
443 final String nodeId = id.getValue().replaceAll(OPENFLOW_ID_PREFIX, "");
444 BigInteger nodeIdRaw = new BigInteger(nodeId);
445 long lNodeId = nodeIdRaw.longValue();
446 byte[] bytesFromDpid = ToSalConversionsUtils.bytesFromDpid(lNodeId);
447 return new MacAddress(bytesFromDpid);
450 public static Tables toADTables(final Short tables) {
451 return new Tables(tables.byteValue());
454 public static Capabilities toADCapabiliities(final List<Class<? extends FeatureCapability>> capabilities) {
457 for (Class<? extends FeatureCapability> capability : capabilities) {
458 if (capability.equals(FlowFeatureCapabilityFlowStats.class)) {
459 b = Capabilities.CapabilitiesType.FLOW_STATS_CAPABILITY.getValue() | b;
460 } else if (capability.equals(FlowFeatureCapabilityTableStats.class)) {
461 b = Capabilities.CapabilitiesType.TABLE_STATS_CAPABILITY.getValue() | b;
462 } else if (capability.equals(FlowFeatureCapabilityPortStats.class)) {
463 b = Capabilities.CapabilitiesType.PORT_STATS_CAPABILITY.getValue() | b;
464 } else if (capability.equals(FlowFeatureCapabilityStp.class)) {
465 b = Capabilities.CapabilitiesType.STP_CAPABILITY.getValue() | b;
466 } else if (capability.equals(FlowFeatureCapabilityIpReasm.class)) {
467 b = Capabilities.CapabilitiesType.IP_REASSEM_CAPABILITY.getValue() | b;
468 } else if (capability.equals(FlowFeatureCapabilityQueueStats.class)) {
469 b = Capabilities.CapabilitiesType.QUEUE_STATS_CAPABILITY.getValue() | b;
470 } else if (capability.equals(FlowFeatureCapabilityArpMatchIp.class)) {
471 b = Capabilities.CapabilitiesType.ARP_MATCH_IP_CAPABILITY.getValue() | b;
474 return new Capabilities(b);
477 public static Buffers toADBuffers(final Long buffers) {
478 return new Buffers(buffers.intValue());
482 private static final boolean isInteger(String value) {
483 if (value.isEmpty()) return false;
484 for (int i = 0; i < value.length(); i++) {
485 if (i == 0 && value.charAt(i) == '-') {
486 if (value.length() == 1) return false;
489 if (Character.digit(value.charAt(i), 10) < 0) return false;