opendaylight/md-sal/compatibility/sal-compatibility/src/main/java/org/opendaylight/controller/sal/compatibility/FromSalConversionsUtils.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.sal.compatibility;
   9
  10 import static org.opendaylight.controller.sal.compatibility.ProtocolConstants.CRUDP;
  11 import static org.opendaylight.controller.sal.compatibility.ProtocolConstants.ETHERNET_ARP;
  12 import static org.opendaylight.controller.sal.compatibility.ProtocolConstants.TCP;
  13 import static org.opendaylight.controller.sal.compatibility.ProtocolConstants.UDP;
  14 import static org.opendaylight.controller.sal.match.MatchType.DL_DST;
  15 import static org.opendaylight.controller.sal.match.MatchType.DL_SRC;
  16 import static org.opendaylight.controller.sal.match.MatchType.DL_TYPE;
  17
  18 import java.net.Inet4Address;
  19 import java.net.Inet6Address;
  20 import java.net.InetAddress;
  21
  22 import org.opendaylight.controller.sal.core.NodeConnector;
  23 import org.opendaylight.controller.sal.match.Match;
  24 import org.opendaylight.controller.sal.match.MatchField;
  25 import org.opendaylight.controller.sal.match.MatchType;
  26 import org.opendaylight.controller.sal.utils.NetUtils;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Dscp;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.address.Ipv4Builder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.address.Ipv6Builder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpSourceHardwareAddressBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpTargetHardwareAddressBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetDestinationBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetSourceBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatch;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatch;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatchBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer4Match;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatch;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatchBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatchBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.SctpMatchBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatchBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.vlan.match.fields.VlanIdBuilder;
  61
  62 import com.google.common.net.InetAddresses;
  63
  64 public class FromSalConversionsUtils {
  65
  66     private FromSalConversionsUtils() {
  67
  68     }
  69
  70     @SuppressWarnings("unused")
  71     private static Address addressFromAction(InetAddress inetAddress) {
  72         String strInetAddresss = InetAddresses.toAddrString(inetAddress);
  73         if (inetAddress instanceof Inet4Address) {
  74             Ipv4Builder ipv4Builder = new Ipv4Builder();
  75             ipv4Builder.setIpv4Address(new Ipv4Prefix(strInetAddresss));
  76             return ipv4Builder.build();
  77         } else if (inetAddress instanceof Inet6Address) {
  78             Ipv6Builder ipv6Builder = new Ipv6Builder();
  79             ipv6Builder.setIpv6Address(new Ipv6Prefix(strInetAddresss));
  80             return ipv6Builder.build();
  81         }
  82         return null;
  83     }
  84
  85     public static org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match toMatch(
  86             Match sourceMatch) {
  87         if (sourceMatch != null) {
  88             MatchBuilder targetBuilder = new MatchBuilder();
  89
  90             targetBuilder.setEthernetMatch(ethernetMatch(sourceMatch));
  91             targetBuilder.setIpMatch(ipMatch(sourceMatch));
  92             targetBuilder.setVlanMatch(vlanMatch(sourceMatch));
  93             targetBuilder.setLayer3Match(layer3Match(sourceMatch));
  94             targetBuilder.setLayer4Match(layer4Match(sourceMatch));
  95             targetBuilder.setInPort(inPortMatch(sourceMatch));
  96
  97             return targetBuilder.build();
  98         }
  99         return null;
 100
 101     }
 102
 103     private static NodeConnectorId inPortMatch(Match sourceMatch) {
 104         MatchField inPort = sourceMatch.getField(MatchType.IN_PORT);
 105         if(inPort != null && inPort.getValue() != null && (inPort.getValue() instanceof NodeConnector)) {
 106             return new NodeConnectorId(((NodeConnector) inPort.getValue()).getNodeConnectorIdAsString());
 107         }
 108         return null;
 109     }
 110
 111     private static Layer4Match layer4Match(final Match sourceMatch) {
 112         MatchField nwProto = sourceMatch.getField(MatchType.NW_PROTO);
 113         Short nwProtocolSource = null;
 114         if (nwProto != null && nwProto.getValue() != null) {
 115             nwProtocolSource = (short) ((byte) nwProto.getValue());
 116             switch (nwProtocolSource) {
 117             case TCP:
 118                 return Layer4MatchAsTcp(sourceMatch);
 119             case UDP:
 120                 return Layer4MatchAsUdp(sourceMatch);
 121             case CRUDP:
 122                 return Layer4MatchAsSctp(sourceMatch);
 123             }
 124         }
 125         return null;
 126     }
 127
 128     private static Layer4Match Layer4MatchAsSctp(final Match sourceMatch) {
 129         SctpMatchBuilder sctpMatchBuilder = new SctpMatchBuilder();
 130
 131         Integer sourcePort = transportPort(sourceMatch, MatchType.TP_SRC);
 132         Integer destinationPort = transportPort(sourceMatch,
 133                 MatchType.TP_DST);
 134
 135         if (sourcePort != null) {
 136             sctpMatchBuilder.setSctpSourcePort(new PortNumber(sourcePort));
 137         }
 138         if (destinationPort != null) {
 139             sctpMatchBuilder.setSctpDestinationPort(new PortNumber(
 140                     destinationPort));
 141         }
 142         if(sourcePort != null || destinationPort != null) {
 143             return sctpMatchBuilder.build();
 144         }
 145         return null;
 146     }
 147
 148     private static Layer4Match Layer4MatchAsUdp(final Match sourceMatch) {
 149         UdpMatchBuilder udpMatchBuilder = new UdpMatchBuilder();
 150
 151         Integer sourcePort = transportPort(sourceMatch, MatchType.TP_SRC);
 152         Integer destinationPort = transportPort(sourceMatch,
 153                 MatchType.TP_DST);
 154
 155         if (sourcePort != null) {
 156             udpMatchBuilder.setUdpSourcePort(new PortNumber(sourcePort));
 157         }
 158
 159         if (destinationPort != null) {
 160             udpMatchBuilder.setUdpDestinationPort(new PortNumber(
 161                     destinationPort));
 162         }
 163         if(sourcePort != null || destinationPort != null) {
 164             return udpMatchBuilder.build();
 165         }
 166         return null;
 167     }
 168
 169     private static Layer4Match Layer4MatchAsTcp(final Match sourceMatch) {
 170         TcpMatchBuilder tcpMatchBuilder = new TcpMatchBuilder();
 171
 172         Integer sourcePort = transportPort(sourceMatch, MatchType.TP_SRC);
 173         Integer destinationPort = transportPort(sourceMatch,
 174                 MatchType.TP_DST);
 175
 176         if (sourcePort != null) {
 177             tcpMatchBuilder.setTcpSourcePort(new PortNumber(sourcePort));
 178         }
 179         if (destinationPort != null) {
 180             tcpMatchBuilder.setTcpDestinationPort(new PortNumber(
 181                     destinationPort));
 182         }
 183         if(sourcePort != null || destinationPort != null) {
 184             return tcpMatchBuilder.build();
 185         }
 186         return null;
 187     }
 188
 189     private static Integer transportPort(final Match sourceMatch,
 190             final MatchType matchType) {
 191         MatchField transportPort = sourceMatch.getField(matchType);
 192         if (transportPort != null && transportPort.getValue() != null
 193                 && transportPort.getValue().getClass().equals(Short.class)) {
 194             return new Integer(NetUtils.getUnsignedShort((short) transportPort
 195                     .getValue()));
 196         }
 197         return null;
 198     }
 199
 200     private static VlanMatch vlanMatch(final Match sourceMatch) {
 201         VlanMatchBuilder vlanMatchBuild = new VlanMatchBuilder();
 202
 203         MatchField vlan = sourceMatch.getField(MatchType.DL_VLAN);
 204         if (vlan != null && vlan.getValue() != null) {
 205             VlanIdBuilder vlanIDBuilder = new VlanIdBuilder();
 206             vlanIDBuilder.setVlanId(new VlanId((NetUtils
 207                     .getUnsignedShort((short) vlan.getValue()))));
 208             vlanMatchBuild.setVlanId(vlanIDBuilder.build());
 209         }
 210
 211         MatchField vlanPriority = sourceMatch.getField(MatchType.DL_VLAN_PR);
 212         if (vlanPriority != null && vlanPriority.getValue() != null) {
 213             vlanMatchBuild.setVlanPcp(new VlanPcp((short) ((byte) vlanPriority
 214                     .getValue())));
 215         }
 216         if((vlan != null && vlan.getValue() != null) || (vlanPriority != null && vlanPriority.getValue() != null)) {
 217             return vlanMatchBuild.build();
 218         }
 219         return null;
 220     }
 221
 222     private static IpMatch ipMatch(final Match sourceMatch) {
 223         IpMatchBuilder targetIpMatchBuild = new IpMatchBuilder();
 224         MatchField networkTos = sourceMatch.getField(MatchType.NW_TOS);
 225         if (networkTos != null && networkTos.getValue() != null) {
 226             Dscp dscp = new Dscp(
 227                     (short) (NetUtils.getUnsignedByte((Byte) networkTos
 228                             .getValue())));
 229             targetIpMatchBuild.setIpDscp(dscp);
 230         }
 231
 232         MatchField protocol = sourceMatch.getField(MatchType.NW_PROTO);
 233         if (protocol != null && protocol.getValue() != null) {
 234             targetIpMatchBuild.setIpProtocol((short) ((byte) protocol
 235                     .getValue()));
 236         }
 237         if((networkTos != null && networkTos.getValue() != null) || (protocol != null && protocol.getValue() != null)) {
 238             return targetIpMatchBuild.build();
 239         }
 240         return null;
 241     }
 242
 243     private static EthernetMatch ethernetMatch(final Match sourceMatch) {
 244         final EthernetMatchBuilder targetEthMatchBuild = new EthernetMatchBuilder();
 245         if(sourceMatch.getField(DL_SRC) != null && sourceMatch.getField(DL_SRC).getValue() != null) {
 246             EthernetSourceBuilder ethSourBuild = new EthernetSourceBuilder()
 247                     .setAddress(ethernetSourceAddress(sourceMatch));
 248             targetEthMatchBuild.setEthernetSource(ethSourBuild.build());
 249         }
 250         if(sourceMatch.getField(DL_DST) != null && sourceMatch.getField(DL_DST).getValue() != null) {
 251             EthernetDestinationBuilder ethDestBuild = new EthernetDestinationBuilder()
 252                     .setAddress(ethernetDestAddress(sourceMatch));
 253             targetEthMatchBuild.setEthernetDestination(ethDestBuild.build());
 254         }
 255
 256         final MatchField dataLinkType = sourceMatch.getField(MatchType.DL_TYPE);
 257         if (dataLinkType != null && dataLinkType.getValue() != null) {
 258             EtherType etherType = new EtherType(new Long(
 259                     NetUtils.getUnsignedShort((Short) dataLinkType.getValue())));
 260             EthernetTypeBuilder ethType = new EthernetTypeBuilder()
 261                     .setType(etherType);
 262             targetEthMatchBuild.setEthernetType(ethType.build());
 263         }
 264         if((sourceMatch.getField(DL_SRC) != null && sourceMatch.getField(DL_SRC).getValue() != null) ||
 265                 (sourceMatch.getField(DL_DST) != null && sourceMatch.getField(DL_DST).getValue() != null)||
 266                 dataLinkType != null ) {
 267             return targetEthMatchBuild.build();
 268         }
 269         return null;
 270     }
 271
 272     private static MacAddress ethernetSourceAddress(final Match sourceMatch) {
 273         final MatchField dataLinkSource = sourceMatch.getField(DL_SRC);
 274         if (dataLinkSource != null && dataLinkSource.getValue() != null) {
 275             return MDFlowMapping.toMacAddress((byte[])dataLinkSource.getValue());
 276         }
 277         return null;
 278
 279     }
 280
 281     private static Layer3Match layer3Match(final Match sourceMatch) {
 282         InetAddress inetSourceAddress = null;
 283         MatchField netSource = sourceMatch.getField(MatchType.NW_SRC);
 284         if (netSource != null && netSource.getValue() != null) {
 285             inetSourceAddress = (InetAddress) (netSource.getValue());
 286         }
 287
 288         InetAddress inetDestAddress = null;
 289         MatchField netDest = sourceMatch.getField(MatchType.NW_DST);
 290         if (netDest != null && netDest.getValue() != null) {
 291             inetDestAddress = (InetAddress) (netDest.getValue());
 292         }
 293
 294         if ((inetSourceAddress instanceof Inet4Address)
 295                 || (inetDestAddress instanceof Inet4Address)) {
 296             MatchField dataLinkType = sourceMatch.getField(DL_TYPE);
 297             Short dLType = null;
 298             if (dataLinkType != null && dataLinkType.getValue() != null) {
 299                 dLType = (Short) (dataLinkType.getValue());
 300             }
 301             if (dLType != null && dLType.equals(ETHERNET_ARP)) {
 302                 return setLayer3MatchAsArp(sourceMatch,
 303                         (Inet4Address) inetSourceAddress,
 304                         (Inet4Address) inetDestAddress);
 305             } else {
 306                 return setLayer3MatchAsIpv4((Inet4Address) inetSourceAddress,
 307                         (Inet4Address) inetDestAddress);
 308             }
 309         } else if ((inetSourceAddress instanceof Inet6Address)
 310                 || (inetDestAddress instanceof Inet6Address)) {
 311             return setLayer3MatchAsIpv6((Inet6Address) inetSourceAddress,
 312                     (Inet6Address) inetDestAddress);
 313         }
 314
 315         return null;
 316
 317     }
 318
 319     private static Layer3Match setLayer3MatchAsArp(final Match sourceMatch,
 320             final Inet4Address inetSourceAddress,
 321             final Inet4Address inetDestAddress) {
 322         String inetSourceAddressStr = InetAddresses
 323                 .toAddrString(inetSourceAddress);
 324         Ipv4Prefix ipv4SourcePrefix = new Ipv4Prefix(inetSourceAddressStr);
 325
 326         String inetDestAddressValue = InetAddresses
 327                 .toAddrString(inetDestAddress);
 328         Ipv4Prefix ipv4DestPrefix = new Ipv4Prefix(inetDestAddressValue);
 329
 330         ArpMatchBuilder arpMatchBuilder = new ArpMatchBuilder();
 331
 332         arpMatchBuilder.setArpSourceTransportAddress(ipv4SourcePrefix);
 333         arpMatchBuilder.setArpTargetTransportAddress(ipv4DestPrefix);
 334
 335         ArpSourceHardwareAddressBuilder arpSourceHardwareAddressBuilder = new ArpSourceHardwareAddressBuilder();
 336         arpSourceHardwareAddressBuilder
 337                 .setAddress(ethernetSourceAddress(sourceMatch));
 338         arpMatchBuilder
 339                 .setArpSourceHardwareAddress(arpSourceHardwareAddressBuilder
 340                         .build());
 341
 342         ArpTargetHardwareAddressBuilder arpTargetHardwareAddressBuilder = new ArpTargetHardwareAddressBuilder();
 343         arpTargetHardwareAddressBuilder
 344                 .setAddress(ethernetDestAddress(sourceMatch));
 345         arpMatchBuilder
 346                 .setArpTargetHardwareAddress(arpTargetHardwareAddressBuilder
 347                         .build());
 348
 349         return arpMatchBuilder.build();
 350
 351     }
 352
 353     private static MacAddress ethernetDestAddress(final Match sourceMatch) {
 354         final MatchField dataLinkDest = sourceMatch.getField(DL_DST);
 355         if (dataLinkDest != null && dataLinkDest.getValue() != null) {
 356             return MDFlowMapping.toMacAddress((byte[]) dataLinkDest.getValue());
 357         }
 358         return null;
 359     }
 360
 361     private static Layer3Match setLayer3MatchAsIpv4(
 362             final Inet4Address inetSourceAddress,
 363             final Inet4Address inetDestAddress) {
 364         Ipv4MatchBuilder layer4MatchBuild = new Ipv4MatchBuilder();
 365         if(inetSourceAddress != null) {
 366             String inetSrcAddressString = InetAddresses
 367                     .toAddrString(inetSourceAddress);
 368             layer4MatchBuild.setIpv4Source(new Ipv4Prefix(inetSrcAddressString));
 369         }
 370         if(inetDestAddress != null) {
 371             String inetDstAddressString = InetAddresses
 372                     .toAddrString(inetDestAddress);
 373             layer4MatchBuild
 374             .setIpv4Destination(new Ipv4Prefix(inetDstAddressString));
 375         }
 376         return layer4MatchBuild.build();
 377
 378     }
 379
 380     private static Layer3Match setLayer3MatchAsIpv6(
 381             final Inet6Address inetSourceAddress,
 382             final Inet6Address inetDestAddress) {
 383         Ipv6MatchBuilder layer6MatchBuild = new Ipv6MatchBuilder();
 384         if(inetSourceAddress != null) {
 385             String inetSrcAddressString = InetAddresses
 386                     .toAddrString(inetSourceAddress);
 387             layer6MatchBuild.setIpv6Source(new Ipv6Prefix(inetSrcAddressString));
 388         }
 389         if(inetDestAddress != null) {
 390             String inetDstAddressString = InetAddresses
 391                     .toAddrString(inetDestAddress);
 392             layer6MatchBuild
 393                     .setIpv6Destination(new Ipv6Prefix(inetDstAddressString));
 394         }
 395         return layer6MatchBuild.build();
 396     }
 397
 398     public static boolean flowEquals(Flow statsFlow, Flow storedFlow) {
 399         if (statsFlow.getClass() != storedFlow.getClass()) {
 400             return false;
 401         }
 402         if (statsFlow.getBufferId()== null) {
 403             if (storedFlow.getBufferId() != null) {
 404                 return false;
 405             }
 406         } else if(!statsFlow.getBufferId().equals(storedFlow.getBufferId())) {
 407             return false;
 408         }
 409         if (statsFlow.getContainerName()== null) {
 410             if (storedFlow.getContainerName()!= null) {
 411                 return false;
 412             }
 413         } else if(!statsFlow.getContainerName().equals(storedFlow.getContainerName())) {
 414             return false;
 415         }
 416         if (statsFlow.getCookie()== null) {
 417             if (storedFlow.getCookie()!= null) {
 418                 return false;
 419             }
 420         } else if(!statsFlow.getCookie().equals(storedFlow.getCookie())) {
 421             return false;
 422         }
 423         if (statsFlow.getMatch()== null) {
 424             if (storedFlow.getMatch() != null) {
 425                 return false;
 426             }
 427         } else if(!statsFlow.getMatch().equals(storedFlow.getMatch())) {
 428             return false;
 429         }
 430         if (statsFlow.getCookie()== null) {
 431             if (storedFlow.getCookie()!= null) {
 432                 return false;
 433             }
 434         } else if(!statsFlow.getCookie().equals(storedFlow.getCookie())) {
 435             return false;
 436         }
 437         if (statsFlow.getHardTimeout() == null) {
 438             if (storedFlow.getHardTimeout() != null) {
 439                 return false;
 440             }
 441         } else if(!statsFlow.getHardTimeout().equals(storedFlow.getHardTimeout() )) {
 442             return false;
 443         }
 444         if (statsFlow.getIdleTimeout()== null) {
 445             if (storedFlow.getIdleTimeout() != null) {
 446                 return false;
 447             }
 448         } else if(!statsFlow.getIdleTimeout().equals(storedFlow.getIdleTimeout())) {
 449             return false;
 450         }
 451         if (statsFlow.getPriority() == null) {
 452             if (storedFlow.getPriority() != null) {
 453                 return false;
 454             }
 455         } else if(!statsFlow.getPriority().equals(storedFlow.getPriority())) {
 456             return false;
 457         }
 458         if (statsFlow.getTableId() == null) {
 459             if (storedFlow.getTableId() != null) {
 460                 return false;
 461             }
 462         } else if(!statsFlow.getTableId().equals(storedFlow.getTableId())) {
 463             return false;
 464         }
 465         return true;
 466     }
 467
 468
 469 }