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 org.opendaylight.controller.sal.common.util.Arguments;
18 import org.opendaylight.controller.sal.core.AdvertisedBandwidth;
19 import org.opendaylight.controller.sal.core.Bandwidth;
20 import org.opendaylight.controller.sal.core.Buffers;
21 import org.opendaylight.controller.sal.core.Capabilities;
22 import org.opendaylight.controller.sal.core.Config;
23 import org.opendaylight.controller.sal.core.ConstructionException;
24 import org.opendaylight.controller.sal.core.Description;
25 import org.opendaylight.controller.sal.core.MacAddress;
26 import org.opendaylight.controller.sal.core.Name;
27 import org.opendaylight.controller.sal.core.Node.NodeIDType;
28 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
29 import org.opendaylight.controller.sal.core.PeerBandwidth;
30 import org.opendaylight.controller.sal.core.Property;
31 import org.opendaylight.controller.sal.core.SupportedBandwidth;
32 import org.opendaylight.controller.sal.core.Tables;
33 import org.opendaylight.controller.sal.core.TimeStamp;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FeatureCapability;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnectorUpdated;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdated;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityArpMatchIp;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityFlowStats;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityIpReasm;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityPortStats;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityQueueStats;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityStp;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowFeatureCapabilityTableStats;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowNode;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowNodeConnector;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeatures;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortConfig;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.flow.capable.port.State;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.OutputPortValues;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorUpdated;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
67 public final class NodeMapping {
69 private static final Logger LOG = LoggerFactory
70 .getLogger(NodeMapping.class);
75 public static final String OPENFLOW_ID_PREFIX = "openflow:";
77 public final static String MD_SAL_TYPE = "MD_SAL_DEPRECATED";
79 private final static Class<Node> NODE_CLASS = Node.class;
81 private final static Class<NodeConnector> NODECONNECTOR_CLASS = NodeConnector.class;
83 private NodeMapping() {
84 throw new UnsupportedOperationException("Utility class. Instantiation is not allowed.");
87 public static org.opendaylight.controller.sal.core.Node toADNode(final InstanceIdentifier<? extends Object> node) throws ConstructionException {
88 NodeId nodeId = NodeMapping.toNodeId(node);
89 return NodeMapping.toADNode(nodeId);
92 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeId id) throws ConstructionException {
93 String nodeId = NodeMapping.toADNodeId(id);
94 String nodeIdasNumber = nodeId.replaceFirst("^.*:", "");
95 if (isInteger(nodeIdasNumber)) {
96 Long aDNodeId = openflowFullNodeIdToLong(nodeIdasNumber);
97 return new org.opendaylight.controller.sal.core.Node(NodeIDType.OPENFLOW, aDNodeId);
99 return new org.opendaylight.controller.sal.core.Node(NodeIDType.PRODUCTION, nodeId);
105 * @return nodeId as long
108 public static Long openflowFullNodeIdToLong(String adNodeId) {
109 if (adNodeId == null) {
112 return new BigInteger(adNodeId).longValue();
115 public static NodeId toNodeId(final InstanceIdentifier<?> id) {
116 final NodeKey key = id.firstKeyOf(Node.class, NodeKey.class);
117 Preconditions.checkArgument(key != null, "No node identifier found in %s", id);
122 * @param nodeId containing "<NodeTypeString>:<plainIntegerId>"
123 * @return adNodeId form
125 public static String toADNodeId(final NodeId nodeId) {
126 if (nodeId == null) {
129 return nodeId.getValue();
132 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorRef source) throws ConstructionException {
133 final InstanceIdentifier<?> id = Preconditions.checkNotNull(source.getValue());
134 final NodeConnectorKey key = id.firstKeyOf(NodeConnector.class, NodeConnectorKey.class);
135 return NodeMapping.toADNodeConnector(key.getId(), NodeMapping.toNodeId(id));
138 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorId ncid, final NodeId nid) throws ConstructionException {
139 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
140 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
141 org.opendaylight.controller.sal.core.Node aDNode = NodeMapping.toADNode(nid);
142 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
146 * @param ncid nodeConnector identifier, e.g.: OF:21 or CTRL
148 * @return nodeConnector attached to given node
149 * @throws ConstructionException
151 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(
152 final NodeConnectorId ncid, final org.opendaylight.controller.sal.core.Node aDNode) throws ConstructionException {
153 NodeId nid = NodeMapping.toNodeId(aDNode);
154 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
155 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
156 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
163 private static NodeId toNodeId(org.opendaylight.controller.sal.core.Node aDNode) {
164 return new NodeId(aDNode.getType() + ":" + String.valueOf(aDNode.getID()));
167 public static String toNodeConnectorType(final NodeConnectorId ncId, final NodeId nodeId) {
168 if (ncId.equals(toLocalNodeConnectorId(nodeId))) {
169 return NodeConnectorIDType.SWSTACK;
170 } else if (ncId.equals(toNormalNodeConnectorId(nodeId))) {
171 return NodeConnectorIDType.HWPATH;
172 } else if (ncId.equals(toControllerNodeConnectorId(nodeId))) {
173 return NodeConnectorIDType.CONTROLLER;
175 return NodeConnectorIDType.OPENFLOW;
178 public static Object toADNodeConnectorId(final NodeConnectorId nodeConnectorId, final NodeId nodeId) {
179 if (nodeConnectorId.equals(toLocalNodeConnectorId(nodeId)) ||
180 nodeConnectorId.equals(toNormalNodeConnectorId(nodeId)) ||
181 nodeConnectorId.equals(toControllerNodeConnectorId(nodeId))) {
182 return org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID;
185 String nodeConnectorIdStripped = nodeConnectorId.getValue().replaceFirst("^.*:", "");
186 if (nodeConnectorIdStripped.matches("[0-9]+")) {
187 Short nodeConnectorIdVal = null;
189 nodeConnectorIdVal = Short.valueOf(nodeConnectorIdStripped);
190 } catch (NumberFormatException e) {
191 LOG.warn("nodeConnectorId not supported (short): {}", nodeConnectorIdStripped, e);
193 return nodeConnectorIdVal;
195 return nodeConnectorIdStripped;
198 public static NodeId toAdNodeId(final NodeConnectorId nodeConnectorId) {
199 NodeId nodeId = null;
200 if (nodeConnectorId != null) {
201 nodeId = new NodeId(nodeConnectorId.getValue().replaceFirst(":[0-9]+$", ""));
206 public static NodeConnectorId toControllerNodeConnectorId(final NodeId node) {
207 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.CONTROLLER.toString());
210 public static NodeConnectorId toLocalNodeConnectorId(final NodeId node) {
211 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.LOCAL.toString());
214 public static NodeConnectorId toNormalNodeConnectorId(final NodeId node) {
215 return new NodeConnectorId(node.getValue() + ":" + OutputPortValues.NORMAL.toString());
218 public static NodeRef toNodeRef(final org.opendaylight.controller.sal.core.Node node) {
219 Preconditions.checkArgument(NodeIDType.OPENFLOW.equals(node.getType()));
220 final Long nodeId = Arguments.<Long>checkInstanceOf(node.getID(), Long.class);
221 final NodeKey nodeKey = new NodeKey(new NodeId(OPENFLOW_ID_PREFIX + nodeId));
222 final InstanceIdentifier<Node> nodePath = InstanceIdentifier.builder(Nodes.class).child(NODE_CLASS, nodeKey).toInstance();
223 return new NodeRef(nodePath);
226 public static NodeConnectorRef toNodeConnectorRef(final org.opendaylight.controller.sal.core.NodeConnector nodeConnector) {
228 final NodeRef node = NodeMapping.toNodeRef(nodeConnector.getNode());
229 @SuppressWarnings("unchecked")
230 final InstanceIdentifier<Node> nodePath = ((InstanceIdentifier<Node>) node.getValue());
231 NodeConnectorId nodeConnectorId = null;
233 if (nodeConnector.getID().equals(org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID)) {
234 final NodeId nodeId = toNodeId(nodePath);
235 final String nodeConnectorType = nodeConnector.getType();
236 if (nodeConnectorType.equals(NodeConnectorIDType.SWSTACK)) {
237 nodeConnectorId = toLocalNodeConnectorId(nodeId);
238 } else if (nodeConnectorType.equals(NodeConnectorIDType.HWPATH)) {
239 nodeConnectorId = toNormalNodeConnectorId(nodeId);
240 } else if (nodeConnectorType.equals(NodeConnectorIDType.CONTROLLER)) {
241 nodeConnectorId = toControllerNodeConnectorId(nodeId);
244 nodeConnectorId = new NodeConnectorId(OPENFLOW_ID_PREFIX
245 + Arguments.<Short>checkInstanceOf(nodeConnector.getID(), Short.class));
247 final NodeConnectorKey connectorKey = new NodeConnectorKey(nodeConnectorId);
248 final InstanceIdentifier<NodeConnector> path = nodePath.child(NODECONNECTOR_CLASS, connectorKey);
249 return new NodeConnectorRef(path);
252 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeRef node) throws ConstructionException {
253 return NodeMapping.toADNode(node.getValue());
256 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnectorUpdated nc) {
257 final FlowCapableNodeConnectorUpdated fcncu = nc.<FlowCapableNodeConnectorUpdated>getAugmentation(FlowCapableNodeConnectorUpdated.class);
258 if (!Objects.equal(fcncu, null)) {
259 HashSet<Property> adNodeConnectorProperties = NodeMapping.toADNodeConnectorProperties(fcncu);
260 return adNodeConnectorProperties;
262 return new HashSet<Property>();
267 * @return node description in AD form, e.g.: OF|00:00:00:...:01
269 private static Description toADDescription(NodeRef nodeRef) {
272 desc = new Description(toADNode(nodeRef).toString());
273 } catch (ConstructionException e) {
274 desc = new Description("none");
275 LOG.warn("node description extraction failed: {}", nodeRef);
280 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnector nc) {
281 final FlowCapableNodeConnector fcnc = nc.<FlowCapableNodeConnector>getAugmentation(FlowCapableNodeConnector.class);
282 if (!Objects.equal(fcnc, null)) {
283 return NodeMapping.toADNodeConnectorProperties(fcnc);
285 return new HashSet<Property>();
288 public static HashSet<Property> toADNodeConnectorProperties(final FlowNodeConnector fcncu) {
290 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
292 if (fcncu.getCurrentFeature() != null && toAdBandwidth(fcncu.getCurrentFeature()) != null) {
293 props.add(toAdBandwidth(fcncu.getCurrentFeature()));
295 if (fcncu.getAdvertisedFeatures() != null && toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()) != null) {
296 props.add(toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()));
298 if (fcncu.getSupported() != null && toAdSupportedBandwidth(fcncu.getSupported()) != null) {
299 props.add(toAdSupportedBandwidth(fcncu.getSupported()));
301 if (fcncu.getPeerFeatures() != null && toAdPeerBandwidth(fcncu.getPeerFeatures()) != null) {
302 props.add(toAdPeerBandwidth(fcncu.getPeerFeatures()));
304 if (fcncu.getName() != null && toAdName(fcncu.getName()) != null) {
305 props.add(toAdName(fcncu.getName()));
307 if (fcncu.getConfiguration() != null && toAdConfig(fcncu.getConfiguration()) != null) {
308 props.add(toAdConfig(fcncu.getConfiguration()));
310 if (fcncu.getState() != null && toAdState(fcncu.getState()) != null) {
311 props.add(toAdState(fcncu.getState()));
317 public static Name toAdName(final String name) {
318 return new Name(name);
321 public static Config toAdConfig(final PortConfig pc) {
322 Config config = null;
323 if (pc.isPORTDOWN()) {
324 config = new Config(Config.ADMIN_DOWN);
326 config = new Config(Config.ADMIN_UP);
331 public static org.opendaylight.controller.sal.core.State toAdState(final State s) {
333 org.opendaylight.controller.sal.core.State state = null;
334 if (s.isLinkDown()) {
335 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_DOWN);
337 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_UP);
342 public static Bandwidth toAdBandwidth(final PortFeatures pf) {
344 if (pf.isTenMbHd() || pf.isTenMbFd()) {
345 bw = new Bandwidth(Bandwidth.BW10Mbps);
346 } else if (pf.isHundredMbHd() || pf.isHundredMbFd()) {
347 bw = new Bandwidth(Bandwidth.BW100Mbps);
348 } else if (pf.isOneGbHd() || pf.isOneGbFd()) {
349 bw = new Bandwidth(Bandwidth.BW1Gbps);
350 } else if (pf.isOneGbFd()) {
351 bw = new Bandwidth(Bandwidth.BW10Gbps);
352 } else if (pf.isTenGbFd()) {
353 bw = new Bandwidth(Bandwidth.BW10Gbps);
354 } else if (pf.isFortyGbFd()) {
355 bw = new Bandwidth(Bandwidth.BW40Gbps);
356 } else if (pf.isHundredGbFd()) {
357 bw = new Bandwidth(Bandwidth.BW100Gbps);
358 } else if (pf.isOneTbFd()) {
359 bw = new Bandwidth(Bandwidth.BW1Tbps);
364 public static AdvertisedBandwidth toAdAdvertizedBandwidth(final PortFeatures pf) {
365 AdvertisedBandwidth abw = null;
366 final Bandwidth bw = toAdBandwidth(pf);
368 abw = new AdvertisedBandwidth(bw.getValue());
373 public static SupportedBandwidth toAdSupportedBandwidth(final PortFeatures pf) {
374 SupportedBandwidth sbw = null;
375 final Bandwidth bw = toAdBandwidth(pf);
377 sbw = new SupportedBandwidth(bw.getValue());
382 public static PeerBandwidth toAdPeerBandwidth(final PortFeatures pf) {
383 PeerBandwidth pbw = null;
384 final Bandwidth bw = toAdBandwidth(pf);
386 pbw = new PeerBandwidth(bw.getValue());
391 public static HashSet<Property> toADNodeProperties(final NodeUpdated nu) {
392 final FlowCapableNodeUpdated fcnu = nu.getAugmentation(FlowCapableNodeUpdated.class);
394 HashSet<Property> adNodeProperties = toADNodeProperties(fcnu, nu.getId());
395 adNodeProperties.add(toADDescription(nu.getNodeRef()));
396 return adNodeProperties;
398 return new HashSet<org.opendaylight.controller.sal.core.Property>();
401 public static HashSet<Property> toADNodeProperties(final FlowNode fcnu, final NodeId id) {
403 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
406 props.add(toADTimestamp());
408 // props.add(fcnu.supportedActions.toADActions) - TODO
410 props.add(toADMacAddress(id));
412 SwitchFeatures switchFeatures = fcnu.getSwitchFeatures();
413 if (switchFeatures != null) {
414 if (switchFeatures.getMaxTables() != null) {
415 props.add(toADTables(switchFeatures.getMaxTables()));
417 if (switchFeatures.getCapabilities() != null) {
418 props.add(toADCapabiliities(switchFeatures.getCapabilities()));
420 if (switchFeatures.getMaxBuffers() != null) {
421 props.add(toADBuffers(switchFeatures.getMaxBuffers()));
428 public static TimeStamp toADTimestamp() {
429 final Date date = new Date();
430 final TimeStamp timestamp = new TimeStamp(date.getTime(), "connectedSince");
434 public static MacAddress toADMacAddress(final NodeId id) {
435 final String nodeId = id.getValue().replaceAll(OPENFLOW_ID_PREFIX, "");
436 BigInteger nodeIdRaw = new BigInteger(nodeId);
437 long lNodeId = nodeIdRaw.longValue();
438 byte[] bytesFromDpid = ToSalConversionsUtils.bytesFromDpid(lNodeId);
439 return new MacAddress(bytesFromDpid);
442 public static Tables toADTables(final Short tables) {
443 return new Tables(tables.byteValue());
446 public static Capabilities toADCapabiliities(final List<Class<? extends FeatureCapability>> capabilities) {
449 for (Class<? extends FeatureCapability> capability : capabilities) {
450 if (capability.equals(FlowFeatureCapabilityFlowStats.class)) {
451 b = Capabilities.CapabilitiesType.FLOW_STATS_CAPABILITY.getValue() | b;
452 } else if (capability.equals(FlowFeatureCapabilityTableStats.class)) {
453 b = Capabilities.CapabilitiesType.TABLE_STATS_CAPABILITY.getValue() | b;
454 } else if (capability.equals(FlowFeatureCapabilityPortStats.class)) {
455 b = Capabilities.CapabilitiesType.PORT_STATS_CAPABILITY.getValue() | b;
456 } else if (capability.equals(FlowFeatureCapabilityStp.class)) {
457 b = Capabilities.CapabilitiesType.STP_CAPABILITY.getValue() | b;
458 } else if (capability.equals(FlowFeatureCapabilityIpReasm.class)) {
459 b = Capabilities.CapabilitiesType.IP_REASSEM_CAPABILITY.getValue() | b;
460 } else if (capability.equals(FlowFeatureCapabilityQueueStats.class)) {
461 b = Capabilities.CapabilitiesType.QUEUE_STATS_CAPABILITY.getValue() | b;
462 } else if (capability.equals(FlowFeatureCapabilityArpMatchIp.class)) {
463 b = Capabilities.CapabilitiesType.ARP_MATCH_IP_CAPABILITY.getValue() | b;
466 return new Capabilities(b);
469 public static Buffers toADBuffers(final Long buffers) {
470 return new Buffers(buffers.intValue());
474 private static final boolean isInteger(String value) {
475 if (value.isEmpty()) return false;
476 for (int i = 0; i < value.length(); i++) {
477 if (i == 0 && value.charAt(i) == '-') {
478 if (value.length() == 1) return false;
481 if (Character.digit(value.charAt(i), 10) < 0) return false;