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 java.math.BigInteger;
11 import java.util.Date;
12 import java.util.HashSet;
13 import java.util.List;
15 import org.opendaylight.controller.sal.common.util.Arguments;
16 import org.opendaylight.controller.sal.core.AdvertisedBandwidth;
17 import org.opendaylight.controller.sal.core.Bandwidth;
18 import org.opendaylight.controller.sal.core.Buffers;
19 import org.opendaylight.controller.sal.core.Capabilities;
20 import org.opendaylight.controller.sal.core.Config;
21 import org.opendaylight.controller.sal.core.ConstructionException;
22 import org.opendaylight.controller.sal.core.MacAddress;
23 import org.opendaylight.controller.sal.core.Name;
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.inventory.rev130819.NodeConnectorId;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorUpdated;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
58 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
60 import com.google.common.base.Objects;
61 import com.google.common.base.Preconditions;
63 public final class NodeMapping {
64 public final static String MD_SAL_TYPE = "MD_SAL";
66 private final static Class<Node> NODE_CLASS = Node.class;
68 private final static Class<NodeConnector> NODECONNECTOR_CLASS = NodeConnector.class;
70 private NodeMapping() {
71 throw new UnsupportedOperationException("Utility class. Instantiation is not allowed.");
74 public static org.opendaylight.controller.sal.core.Node toADNode(final InstanceIdentifier<? extends Object> node) throws ConstructionException {
75 NodeId nodeId = NodeMapping.toNodeId(node);
76 return NodeMapping.toADNode(nodeId);
79 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeId id) throws ConstructionException {
80 String aDNodeId = NodeMapping.toADNodeId(id);
81 return new org.opendaylight.controller.sal.core.Node(NodeMapping.MD_SAL_TYPE, aDNodeId);
84 public static NodeId toNodeId(final InstanceIdentifier<?> id) {
85 final NodeKey key = id.firstKeyOf(Node.class, NodeKey.class);
86 Preconditions.checkArgument(key != null, "No node identifier found in %s", id);
90 public static String toADNodeId(final NodeId nodeId) {
91 return nodeId.getValue();
94 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorRef source) throws ConstructionException {
95 final InstanceIdentifier<?> id = Preconditions.checkNotNull(source.getValue());
96 final NodeConnectorKey key = id.firstKeyOf(NodeConnector.class, NodeConnectorKey.class);
97 return NodeMapping.toADNodeConnector(key.getId(), NodeMapping.toNodeId(id));
100 public static org.opendaylight.controller.sal.core.NodeConnector toADNodeConnector(final NodeConnectorId ncid, final NodeId nid) throws ConstructionException {
101 String nodeConnectorType = NodeMapping.toNodeConnectorType(ncid, nid);
102 Object aDNodeConnectorId = NodeMapping.toADNodeConnectorId(ncid, nid);
103 org.opendaylight.controller.sal.core.Node aDNode = NodeMapping.toADNode(nid);
104 return new org.opendaylight.controller.sal.core.NodeConnector(nodeConnectorType, aDNodeConnectorId, aDNode);
107 public static String toNodeConnectorType(final NodeConnectorId ncId, final NodeId nodeId) {
108 if (ncId.equals(toLocalNodeConnectorId(nodeId))) {
109 return NodeConnectorIDType.SWSTACK;
110 } else if (ncId.equals(toNormalNodeConnectorId(nodeId))) {
111 return NodeConnectorIDType.HWPATH;
112 } else if (ncId.equals(toControllerNodeConnectorId(nodeId))) {
113 return NodeConnectorIDType.CONTROLLER;
118 public static Object toADNodeConnectorId(final NodeConnectorId nodeConnectorId, final NodeId nodeId) {
119 if (nodeConnectorId.equals(toLocalNodeConnectorId(nodeId)) ||
120 nodeConnectorId.equals(toNormalNodeConnectorId(nodeId)) ||
121 nodeConnectorId.equals(toControllerNodeConnectorId(nodeId))) {
122 return org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID;
124 return nodeConnectorId.getValue();
127 public static NodeId toAdNodeId(final NodeConnectorId nodeConnectorId) {
128 NodeId nodeId = null;
129 if (nodeConnectorId != null) {
130 nodeId = new NodeId(nodeConnectorId.getValue().replaceFirst(":[0-9]+$", ""));
135 public static NodeConnectorId toControllerNodeConnectorId(final NodeId node) {
136 return new NodeConnectorId(node.getValue() + ":" + 4294967293L);
139 public static NodeConnectorId toLocalNodeConnectorId(final NodeId node) {
140 return new NodeConnectorId(node.getValue() + ":" + 4294967294L);
143 public static NodeConnectorId toNormalNodeConnectorId(final NodeId node) {
144 return new NodeConnectorId(node.getValue() + ":" + 4294967290L);
147 public static NodeRef toNodeRef(final org.opendaylight.controller.sal.core.Node node) {
148 Preconditions.checkArgument(MD_SAL_TYPE.equals(node.getType()));
149 final String nodeId = Arguments.<String>checkInstanceOf(node.getID(), String.class);
150 final NodeKey nodeKey = new NodeKey(new NodeId(nodeId));
151 final InstanceIdentifier<Node> nodePath = InstanceIdentifier.builder(Nodes.class).child(NODE_CLASS, nodeKey).toInstance();
152 return new NodeRef(nodePath);
155 public static NodeConnectorRef toNodeConnectorRef(final org.opendaylight.controller.sal.core.NodeConnector nodeConnector) {
157 final NodeRef node = NodeMapping.toNodeRef(nodeConnector.getNode());
158 @SuppressWarnings("unchecked")
159 final InstanceIdentifier<Node> nodePath = ((InstanceIdentifier<Node>) node.getValue());
160 NodeConnectorId nodeConnectorId = null;
162 if (nodeConnector.getID().equals(org.opendaylight.controller.sal.core.NodeConnector.SPECIALNODECONNECTORID)) {
163 final NodeId nodeId = toNodeId(nodePath);
164 final String nodeConnectorType = nodeConnector.getType();
165 if (nodeConnectorType.equals(NodeConnectorIDType.SWSTACK)) {
166 nodeConnectorId = toLocalNodeConnectorId(nodeId);
167 } else if (nodeConnectorType.equals(NodeConnectorIDType.HWPATH)) {
168 nodeConnectorId = toNormalNodeConnectorId(nodeId);
169 } else if (nodeConnectorType.equals(NodeConnectorIDType.CONTROLLER)) {
170 nodeConnectorId = toControllerNodeConnectorId(nodeId);
173 nodeConnectorId = new NodeConnectorId(Arguments.<String>checkInstanceOf(nodeConnector.getID(), String.class));
175 final NodeConnectorKey connectorKey = new NodeConnectorKey(nodeConnectorId);
176 final InstanceIdentifier<NodeConnector> path = nodePath.child(NODECONNECTOR_CLASS, connectorKey);
177 return new NodeConnectorRef(path);
180 public static org.opendaylight.controller.sal.core.Node toADNode(final NodeRef node) throws ConstructionException {
181 return NodeMapping.toADNode(node.getValue());
184 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnectorUpdated nc) {
185 final FlowCapableNodeConnectorUpdated fcncu = nc.<FlowCapableNodeConnectorUpdated>getAugmentation(FlowCapableNodeConnectorUpdated.class);
186 if (!Objects.equal(fcncu, null)) {
187 return NodeMapping.toADNodeConnectorProperties(fcncu);
189 return new HashSet<Property>();
192 public static HashSet<Property> toADNodeConnectorProperties(final NodeConnector nc) {
193 final FlowCapableNodeConnector fcnc = nc.<FlowCapableNodeConnector>getAugmentation(FlowCapableNodeConnector.class);
194 if (!Objects.equal(fcnc, null)) {
195 return NodeMapping.toADNodeConnectorProperties(fcnc);
197 return new HashSet<Property>();
200 public static HashSet<Property> toADNodeConnectorProperties(final FlowNodeConnector fcncu) {
202 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
204 if (fcncu.getCurrentFeature() != null && toAdBandwidth(fcncu.getCurrentFeature()) != null) {
205 props.add(toAdBandwidth(fcncu.getCurrentFeature()));
207 if (fcncu.getAdvertisedFeatures() != null && toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()) != null) {
208 props.add(toAdAdvertizedBandwidth(fcncu.getAdvertisedFeatures()));
210 if (fcncu.getSupported() != null && toAdSupportedBandwidth(fcncu.getSupported()) != null) {
211 props.add(toAdSupportedBandwidth(fcncu.getSupported()));
213 if (fcncu.getPeerFeatures() != null && toAdPeerBandwidth(fcncu.getPeerFeatures()) != null) {
214 props.add(toAdPeerBandwidth(fcncu.getPeerFeatures()));
216 if (fcncu.getName() != null && toAdName(fcncu.getName()) != null) {
217 props.add(toAdName(fcncu.getName()));
219 if (fcncu.getConfiguration() != null && toAdConfig(fcncu.getConfiguration()) != null) {
220 props.add(toAdConfig(fcncu.getConfiguration()));
222 if (fcncu.getState() != null && toAdState(fcncu.getState()) != null) {
223 props.add(toAdState(fcncu.getState()));
229 public static Name toAdName(final String name) {
230 return new Name(name);
233 public static Config toAdConfig(final PortConfig pc) {
234 Config config = null;
235 if (pc.isPORTDOWN()) {
236 config = new Config(Config.ADMIN_DOWN);
238 config = new Config(Config.ADMIN_UP);
243 public static org.opendaylight.controller.sal.core.State toAdState(final State s) {
245 org.opendaylight.controller.sal.core.State state = null;
246 if (s.isLinkDown()) {
247 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_DOWN);
249 state = new org.opendaylight.controller.sal.core.State(org.opendaylight.controller.sal.core.State.EDGE_UP);
254 public static Bandwidth toAdBandwidth(final PortFeatures pf) {
256 if (pf.isTenMbHd() || pf.isTenMbFd()) {
257 bw = new Bandwidth(Bandwidth.BW10Mbps);
258 } else if (pf.isHundredMbHd() || pf.isHundredMbFd()) {
259 bw = new Bandwidth(Bandwidth.BW100Mbps);
260 } else if (pf.isOneGbHd() || pf.isOneGbFd()) {
261 bw = new Bandwidth(Bandwidth.BW1Gbps);
262 } else if (pf.isOneGbFd()) {
263 bw = new Bandwidth(Bandwidth.BW10Gbps);
264 } else if (pf.isTenGbFd()) {
265 bw = new Bandwidth(Bandwidth.BW10Gbps);
266 } else if (pf.isFortyGbFd()) {
267 bw = new Bandwidth(Bandwidth.BW40Gbps);
268 } else if (pf.isHundredGbFd()) {
269 bw = new Bandwidth(Bandwidth.BW100Gbps);
270 } else if (pf.isOneTbFd()) {
271 bw = new Bandwidth(Bandwidth.BW1Tbps);
276 public static AdvertisedBandwidth toAdAdvertizedBandwidth(final PortFeatures pf) {
277 AdvertisedBandwidth abw = null;
278 final Bandwidth bw = toAdBandwidth(pf);
280 abw = new AdvertisedBandwidth(bw.getValue());
285 public static SupportedBandwidth toAdSupportedBandwidth(final PortFeatures pf) {
286 SupportedBandwidth sbw = null;
287 final Bandwidth bw = toAdBandwidth(pf);
289 sbw = new SupportedBandwidth(bw.getValue());
294 public static PeerBandwidth toAdPeerBandwidth(final PortFeatures pf) {
295 PeerBandwidth pbw = null;
296 final Bandwidth bw = toAdBandwidth(pf);
298 pbw = new PeerBandwidth(bw.getValue());
303 public static HashSet<Property> toADNodeProperties(final NodeUpdated nu) {
304 final FlowCapableNodeUpdated fcnu = nu.getAugmentation(FlowCapableNodeUpdated.class);
306 return toADNodeProperties(fcnu, nu.getId());
308 return new HashSet<org.opendaylight.controller.sal.core.Property>();
311 public static HashSet<Property> toADNodeProperties(final FlowNode fcnu, final NodeId id) {
313 final HashSet<org.opendaylight.controller.sal.core.Property> props = new HashSet<>();
316 props.add(toADTimestamp());
318 // props.add(fcnu.supportedActions.toADActions) - TODO
320 props.add(toADMacAddress(id));
322 SwitchFeatures switchFeatures = fcnu.getSwitchFeatures();
323 if (switchFeatures != null) {
324 if (switchFeatures.getMaxTables() != null) {
325 props.add(toADTables(switchFeatures.getMaxTables()));
327 if (switchFeatures.getCapabilities() != null) {
328 props.add(toADCapabiliities(switchFeatures.getCapabilities()));
330 if (switchFeatures.getMaxBuffers() != null) {
331 props.add(toADBuffers(switchFeatures.getMaxBuffers()));
338 public static TimeStamp toADTimestamp() {
339 final Date date = new Date();
340 final TimeStamp timestamp = new TimeStamp(date.getTime(), "connectedSince");
344 public static MacAddress toADMacAddress(final NodeId id) {
345 final String nodeId = id.getValue().replaceAll("openflow:", "");
346 BigInteger nodeIdRaw = new BigInteger(nodeId);
347 long lNodeId = nodeIdRaw.longValue();
348 byte[] bytesFromDpid = ToSalConversionsUtils.bytesFromDpid(lNodeId);
349 return new MacAddress(bytesFromDpid);
352 public static Tables toADTables(final Short tables) {
353 return new Tables(tables.byteValue());
356 public static Capabilities toADCapabiliities(final List<Class<? extends FeatureCapability>> capabilities) {
359 for (Class<? extends FeatureCapability> capability : capabilities) {
360 if (capability.equals(FlowFeatureCapabilityFlowStats.class)) {
361 b = Capabilities.CapabilitiesType.FLOW_STATS_CAPABILITY.getValue() | b;
362 } else if (capability.equals(FlowFeatureCapabilityTableStats.class)) {
363 b = Capabilities.CapabilitiesType.TABLE_STATS_CAPABILITY.getValue() | b;
364 } else if (capability.equals(FlowFeatureCapabilityPortStats.class)) {
365 b = Capabilities.CapabilitiesType.PORT_STATS_CAPABILITY.getValue() | b;
366 } else if (capability.equals(FlowFeatureCapabilityStp.class)) {
367 b = Capabilities.CapabilitiesType.STP_CAPABILITY.getValue() | b;
368 } else if (capability.equals(FlowFeatureCapabilityIpReasm.class)) {
369 b = Capabilities.CapabilitiesType.IP_REASSEM_CAPABILITY.getValue() | b;
370 } else if (capability.equals(FlowFeatureCapabilityQueueStats.class)) {
371 b = Capabilities.CapabilitiesType.QUEUE_STATS_CAPABILITY.getValue() | b;
372 } else if (capability.equals(FlowFeatureCapabilityArpMatchIp.class)) {
373 b = Capabilities.CapabilitiesType.ARP_MATCH_IP_CAPABILITY.getValue() | b;
376 return new Capabilities(b);
379 public static Buffers toADBuffers(final Long buffers) {
380 return new Buffers(buffers.intValue());