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 org.opendaylight.controller.sal.common.util.Arguments;
14 import org.opendaylight.controller.sal.core.AdvertisedBandwidth;
15 import org.opendaylight.controller.sal.core.Bandwidth;
16 import org.opendaylight.controller.sal.core.Buffers;
17 import org.opendaylight.controller.sal.core.Capabilities;
18 import org.opendaylight.controller.sal.core.Config;
19 import org.opendaylight.controller.sal.core.ConstructionException;
20 import org.opendaylight.controller.sal.core.Description;
21 import org.opendaylight.controller.sal.core.MacAddress;
22 import org.opendaylight.controller.sal.core.Name;
23 import org.opendaylight.controller.sal.core.Node.NodeIDType;
24 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
25 import org.opendaylight.controller.sal.core.PeerBandwidth;
26 import org.opendaylight.controller.sal.core.Property;
27 import org.opendaylight.controller.sal.core.SupportedBandwidth;
28 import org.opendaylight.controller.sal.core.Tables;
29 import org.opendaylight.controller.sal.core.TimeStamp;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FeatureCapability;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnectorUpdated;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdated;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityArpMatchIp;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityFlowStats;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityIpReasm;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityPortStats;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityQueueStats;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityStp;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityTableStats;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowNode;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowNodeConnector;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeatures;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortConfig;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.flow.capable.port.State;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.OutputPortValues;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorUpdated;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
59 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
63 import java.math.BigInteger;
64 import java.util.Date;
65 import java.util.HashSet;
66 import java.util.List;
67 import java.util.regex.Pattern;
69 public final class NodeMapping {
71 private static final Logger LOG = LoggerFactory
72 .getLogger(NodeMapping.class);
77 public static final String OPENFLOW_ID_PREFIX = "openflow:";
79 public final static String MD_SAL_TYPE = "MD_SAL_DEPRECATED";
81 private final static Class<Node> NODE_CLASS = Node.class;
83 private final static Class<NodeConnector> NODECONNECTOR_CLASS = NodeConnector.class;
85 private final static Pattern COLON_NUMBERS_EOL = Pattern.compile(":[0-9]+$");
87 private final static Pattern NUMBERS_ONLY = Pattern.compile("[0-9]+");
89 private final static Pattern ALL_CHARS_TO_COLON = Pattern.compile("^.*:");
91 private NodeMapping() {
92 throw new UnsupportedOperationException("Utility class. Instantiation is not allowed.");
95 public static org.opendaylight.controller.sal.core.Node toADNode(final InstanceIdentifier<? extends Object> node) throws ConstructionException {
96 NodeId nodeId = NodeMapping.toNodeId(node);
97 return NodeMapping.toADNode(nodeId);
100 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeId id) throws ConstructionException {
101 String nodeId = NodeMapping.toADNodeId(id);
102 String nodeIdasNumber = nodeId.replaceFirst("^.*:", "");
103 if (isInteger(nodeIdasNumber)) {
104 Long aDNodeId = openflowFullNodeIdToLong(nodeIdasNumber);
105 return new org.opendaylight.controller.sal.core.Node(NodeIDType.OPENFLOW, aDNodeId);
107 return new org.opendaylight.controller.sal.core.Node(NodeIDType.PRODUCTION, nodeId);
113 * @return nodeId as long
116 public static Long openflowFullNodeIdToLong(String adNodeId) {
117 if (adNodeId == null) {
120 return new BigInteger(adNodeId).longValue();
123 public static NodeId toNodeId(final InstanceIdentifier<?> id) {
124 final NodeKey key = id.firstKeyOf(Node.class, NodeKey.class);
125 Preconditions.checkArgument(key != null, "No node identifier found in %s", id);
130 * @param nodeId containing "<NodeTypeString>:<plainIntegerId>"
131 * @return adNodeId form
133 public static String toADNodeId(final NodeId nodeId) {
134 if (nodeId == null) {
137 return nodeId.getValue();
140 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorRef source) throws ConstructionException {
141 final InstanceIdentifier<?> id = Preconditions.checkNotNull(source.getValue());
142 final NodeConnectorKey key = id.firstKeyOf(NodeConnector.class, NodeConnectorKey.class);
143 return NodeMapping.toADNodeConnector(key.getId(), NodeMapping.toNodeId(id));
146 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorId ncid, final NodeId nid) throws ConstructionException {
147 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
148 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
149 org.opendaylight.controller.sal.core.Node aDNode = NodeMapping.toADNode(nid);
150 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
154 * @param ncid nodeConnector identifier, e.g.: OF:21 or CTRL
156 * @return nodeConnector attached to given node
157 * @throws ConstructionException
159 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(
160 final NodeConnectorId ncid, final org.opendaylight.controller.sal.core.Node aDNode) throws ConstructionException {
161 NodeId nid = NodeMapping.toNodeId(aDNode);
162 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
163 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
164 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
171 public static NodeId toNodeId(org.opendaylight.controller.sal.core.Node aDNode) {
172 String targetPrefix = null;
173 if (NodeIDType.OPENFLOW.equals(aDNode.getType())) {
174 targetPrefix = OPENFLOW_ID_PREFIX;
176 targetPrefix = aDNode.getType() + ":";
179 return new NodeId(targetPrefix + String.valueOf(aDNode.getID()));
184 * @return md-sal {@link NodeKey}
186 public static NodeKey toNodeKey(org.opendaylight.controller.sal.core.Node aDNode) {
187 return new NodeKey(toNodeId(aDNode));
190 public static String toNodeConnectorType(final NodeConnectorId ncId, final NodeId nodeId) {
191 if (ncId.equals(toLocalNodeConnectorId(nodeId))) {
192 return NodeConnectorIDType.SWSTACK;
193 } else if (ncId.equals(toNormalNodeConnectorId(nodeId))) {
194 return NodeConnectorIDType.HWPATH;
195 } else if (ncId.equals(toControllerNodeConnectorId(nodeId))) {
196 return NodeConnectorIDType.CONTROLLER;
198 return NodeConnectorIDType.OPENFLOW;
201 public static Object toADNodeConnectorId(final NodeConnectorId nodeConnectorId, final NodeId nodeId) {
202 if (nodeConnectorId.equals(toLocalNodeConnectorId(nodeId)) ||
203 nodeConnectorId.equals(toNormalNodeConnectorId(nodeId)) ||
204 nodeConnectorId.equals(toControllerNodeConnectorId(nodeId))) {
205 return org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID;
208 String nodeConnectorIdStripped = ALL_CHARS_TO_COLON.matcher(nodeConnectorId.getValue()).replaceFirst("");
210 if (NUMBERS_ONLY.matcher(nodeConnectorIdStripped).matches()) {
211 Short nodeConnectorIdVal = null;
213 nodeConnectorIdVal = Short.valueOf(nodeConnectorIdStripped);
214 return nodeConnectorIdVal;
215 } catch (NumberFormatException e) {
216 LOG.warn("nodeConnectorId not supported (long): {}", nodeConnectorIdStripped, e);
219 return nodeConnectorIdStripped;
222 public static NodeId toAdNodeId(final NodeConnectorId nodeConnectorId) {
223 NodeId nodeId = null;
224 if (nodeConnectorId != null) {
225 nodeId = new NodeId(COLON_NUMBERS_EOL.matcher(nodeConnectorId.getValue()).replaceFirst(""));
230 public static NodeConnectorId toControllerNodeConnectorId(final NodeId node) {
231 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.CONTROLLER.toString());
234 public static NodeConnectorId toLocalNodeConnectorId(final NodeId node) {
235 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.LOCAL.toString());
238 public static NodeConnectorId toNormalNodeConnectorId(final NodeId node) {
239 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.NORMAL.toString());
242 public static NodeRef toNodeRef(final org.opendaylight.controller.sal.core.Node node) {
243 Preconditions.checkArgument(NodeIDType.OPENFLOW.equals(node.getType()));
244 final Long nodeId = Arguments.<Long>checkInstanceOf(node.getID(), Long.class);
245 final NodeKey nodeKey = new NodeKey(new NodeId(OPENFLOW_ID_PREFIX + nodeId));
246 final InstanceIdentifier<Node> nodePath = InstanceIdentifier.builder(Nodes.class).child(NODE_CLASS, nodeKey).toInstance();
247 return new NodeRef(nodePath);
250 public static NodeConnectorRef toNodeConnectorRef(final org.opendaylight.controller.sal.core.NodeConnector nodeConnector) {
252 final NodeRef node = NodeMapping.toNodeRef(nodeConnector.getNode());
253 @SuppressWarnings("unchecked")
254 final InstanceIdentifier<Node> nodePath = ((InstanceIdentifier<Node>) node.getValue());
255 NodeConnectorId nodeConnectorId = null;
257 if (nodeConnector.getID().equals(org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID)) {
258 final NodeId nodeId = toNodeId(nodePath);
259 final String nodeConnectorType = nodeConnector.getType();
260 if (nodeConnectorType.equals(NodeConnectorIDType.SWSTACK)) {
261 nodeConnectorId = toLocalNodeConnectorId(nodeId);
262 } else if (nodeConnectorType.equals(NodeConnectorIDType.HWPATH)) {
263 nodeConnectorId = toNormalNodeConnectorId(nodeId);
264 } else if (nodeConnectorType.equals(NodeConnectorIDType.CONTROLLER)) {
265 nodeConnectorId = toControllerNodeConnectorId(nodeId);
268 nodeConnectorId = new NodeConnectorId(OPENFLOW_ID_PREFIX
269 + Arguments.<Short>checkInstanceOf(nodeConnector.getID(), Short.class));
271 final NodeConnectorKey connectorKey = new NodeConnectorKey(nodeConnectorId);
272 final InstanceIdentifier<NodeConnector> path = nodePath.child(NODECONNECTOR_CLASS, connectorKey);
273 return new NodeConnectorRef(path);
276 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeRef node) throws ConstructionException {
277 return NodeMapping.toADNode(node.getValue());
280 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnectorUpdated nc) {
281 final FlowCapableNodeConnectorUpdated fcncu = nc.<FlowCapableNodeConnectorUpdated>getAugmentation(FlowCapableNodeConnectorUpdated.class);
282 if (!Objects.equal(fcncu, null)) {
283 HashSet<Property> adNodeConnectorProperties = NodeMapping.toADNodeConnectorProperties(fcncu);
284 return adNodeConnectorProperties;
286 return new HashSet<Property>();
291 * @return node description in AD form, e.g.: OF|00:00:00:...:01
293 private static Description toADDescription(NodeRef nodeRef) {
296 desc = new Description(toADNode(nodeRef).toString());
297 } catch (ConstructionException e) {
298 desc = new Description("none");
299 LOG.warn("node description extraction failed: {}", nodeRef);
304 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnector nc) {
305 final FlowCapableNodeConnector fcnc = nc.<FlowCapableNodeConnector>getAugmentation(FlowCapableNodeConnector.class);
306 if (!Objects.equal(fcnc, null)) {
307 return NodeMapping.toADNodeConnectorProperties(fcnc);
309 return new HashSet<Property>();
312 public static HashSet<Property> toADNodeConnectorProperties(final FlowNodeConnector fcncu) {
314 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
316 if (fcncu.getCurrentFeature() != null && toAdBandwidth(fcncu.getCurrentFeature()) != null) {
317 props.add(toAdBandwidth(fcncu.getCurrentFeature()));
319 if (fcncu.getAdvertisedFeatures() != null && toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()) != null) {
320 props.add(toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()));
322 if (fcncu.getSupported() != null && toAdSupportedBandwidth(fcncu.getSupported()) != null) {
323 props.add(toAdSupportedBandwidth(fcncu.getSupported()));
325 if (fcncu.getPeerFeatures() != null && toAdPeerBandwidth(fcncu.getPeerFeatures()) != null) {
326 props.add(toAdPeerBandwidth(fcncu.getPeerFeatures()));
328 if (fcncu.getName() != null && toAdName(fcncu.getName()) != null) {
329 props.add(toAdName(fcncu.getName()));
331 if (fcncu.getConfiguration() != null && toAdConfig(fcncu.getConfiguration()) != null) {
332 props.add(toAdConfig(fcncu.getConfiguration()));
334 if (fcncu.getState() != null && toAdState(fcncu.getState()) != null) {
335 props.add(toAdState(fcncu.getState()));
341 public static Name toAdName(final String name) {
342 return new Name(name);
345 public static Config toAdConfig(final PortConfig pc) {
346 Config config = null;
347 if (pc.isPORTDOWN()) {
348 config = new Config(Config.ADMIN_DOWN);
350 config = new Config(Config.ADMIN_UP);
355 public static org.opendaylight.controller.sal.core.State toAdState(final State s) {
357 org.opendaylight.controller.sal.core.State state = null;
358 if (s.isLinkDown()) {
359 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_DOWN);
361 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_UP);
366 public static Bandwidth toAdBandwidth(final PortFeatures pf) {
368 if (pf.isTenMbHd() || pf.isTenMbFd()) {
369 bw = new Bandwidth(Bandwidth.BW10Mbps);
370 } else if (pf.isHundredMbHd() || pf.isHundredMbFd()) {
371 bw = new Bandwidth(Bandwidth.BW100Mbps);
372 } else if (pf.isOneGbHd() || pf.isOneGbFd()) {
373 bw = new Bandwidth(Bandwidth.BW1Gbps);
374 } else if (pf.isOneGbFd()) {
375 bw = new Bandwidth(Bandwidth.BW10Gbps);
376 } else if (pf.isTenGbFd()) {
377 bw = new Bandwidth(Bandwidth.BW10Gbps);
378 } else if (pf.isFortyGbFd()) {
379 bw = new Bandwidth(Bandwidth.BW40Gbps);
380 } else if (pf.isHundredGbFd()) {
381 bw = new Bandwidth(Bandwidth.BW100Gbps);
382 } else if (pf.isOneTbFd()) {
383 bw = new Bandwidth(Bandwidth.BW1Tbps);
388 public static AdvertisedBandwidth toAdAdvertizedBandwidth(final PortFeatures pf) {
389 AdvertisedBandwidth abw = null;
390 final Bandwidth bw = toAdBandwidth(pf);
392 abw = new AdvertisedBandwidth(bw.getValue());
397 public static SupportedBandwidth toAdSupportedBandwidth(final PortFeatures pf) {
398 SupportedBandwidth sbw = null;
399 final Bandwidth bw = toAdBandwidth(pf);
401 sbw = new SupportedBandwidth(bw.getValue());
406 public static PeerBandwidth toAdPeerBandwidth(final PortFeatures pf) {
407 PeerBandwidth pbw = null;
408 final Bandwidth bw = toAdBandwidth(pf);
410 pbw = new PeerBandwidth(bw.getValue());
415 public static HashSet<Property> toADNodeProperties(final NodeUpdated nu) {
416 final FlowCapableNodeUpdated fcnu = nu.getAugmentation(FlowCapableNodeUpdated.class);
418 HashSet<Property> adNodeProperties = toADNodeProperties(fcnu, nu.getId());
419 adNodeProperties.add(toADDescription(nu.getNodeRef()));
420 return adNodeProperties;
422 return new HashSet<org.opendaylight.controller.sal.core.Property>();
425 public static HashSet<Property> toADNodeProperties(final FlowNode fcnu, final NodeId id) {
427 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
430 props.add(toADTimestamp());
432 // props.add(fcnu.supportedActions.toADActions) - TODO
434 props.add(toADMacAddress(id));
436 SwitchFeatures switchFeatures = fcnu.getSwitchFeatures();
437 if (switchFeatures != null) {
438 if (switchFeatures.getMaxTables() != null) {
439 props.add(toADTables(switchFeatures.getMaxTables()));
441 if (switchFeatures.getCapabilities() != null) {
442 props.add(toADCapabiliities(switchFeatures.getCapabilities()));
444 if (switchFeatures.getMaxBuffers() != null) {
445 props.add(toADBuffers(switchFeatures.getMaxBuffers()));
452 public static TimeStamp toADTimestamp() {
453 final Date date = new Date();
454 final TimeStamp timestamp = new TimeStamp(date.getTime(), "connectedSince");
458 public static MacAddress toADMacAddress(final NodeId id) {
459 final String nodeId = id.getValue().replaceAll(OPENFLOW_ID_PREFIX, "");
460 BigInteger nodeIdRaw = new BigInteger(nodeId);
461 long lNodeId = nodeIdRaw.longValue();
462 byte[] bytesFromDpid = ToSalConversionsUtils.bytesFromDpid(lNodeId);
463 return new MacAddress(bytesFromDpid);
466 public static Tables toADTables(final Short tables) {
467 return new Tables(tables.byteValue());
470 public static Capabilities toADCapabiliities(final List<Class<? extends FeatureCapability>> capabilities) {
473 for (Class<? extends FeatureCapability> capability : capabilities) {
474 if (capability.equals(FlowFeatureCapabilityFlowStats.class)) {
475 b = Capabilities.CapabilitiesType.FLOW_STATS_CAPABILITY.getValue() | b;
476 } else if (capability.equals(FlowFeatureCapabilityTableStats.class)) {
477 b = Capabilities.CapabilitiesType.TABLE_STATS_CAPABILITY.getValue() | b;
478 } else if (capability.equals(FlowFeatureCapabilityPortStats.class)) {
479 b = Capabilities.CapabilitiesType.PORT_STATS_CAPABILITY.getValue() | b;
480 } else if (capability.equals(FlowFeatureCapabilityStp.class)) {
481 b = Capabilities.CapabilitiesType.STP_CAPABILITY.getValue() | b;
482 } else if (capability.equals(FlowFeatureCapabilityIpReasm.class)) {
483 b = Capabilities.CapabilitiesType.IP_REASSEM_CAPABILITY.getValue() | b;
484 } else if (capability.equals(FlowFeatureCapabilityQueueStats.class)) {
485 b = Capabilities.CapabilitiesType.QUEUE_STATS_CAPABILITY.getValue() | b;
486 } else if (capability.equals(FlowFeatureCapabilityArpMatchIp.class)) {
487 b = Capabilities.CapabilitiesType.ARP_MATCH_IP_CAPABILITY.getValue() | b;
490 return new Capabilities(b);
493 public static Buffers toADBuffers(final Long buffers) {
494 return new Buffers(buffers.intValue());
498 private static final boolean isInteger(String value) {
499 if (value.isEmpty()) return false;
500 for (int i = 0; i < value.length(); i++) {
501 if (i == 0 && value.charAt(i) == '-') {
502 if (value.length() == 1) return false;
505 if (Character.digit(value.charAt(i), 10) < 0) return false;