2 * Copyright (c) 2015 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
9 package org.opendaylight.openflowplugin.impl.util;
11 import java.math.BigInteger;
12 import java.util.StringTokenizer;
14 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
15 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
16 import org.opendaylight.openflowplugin.openflow.md.util.OpenflowPortsUtil;
17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpVersion;
18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpSourceHardwareAddress;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpTargetHardwareAddress;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetDestination;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetSource;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetType;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatch;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv4Match;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv6Match;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatch;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer4Match;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Metadata;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.ProtocolMatchFields;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TcpFlagMatch;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Tunnel;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatch;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatch;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4Match;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6Match;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.TunnelIpv4Match;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.SctpMatch;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatch;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatch;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.protocol.match.fields.Pbb;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.vlan.match.fields.VlanId;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
55 * Created by Martin Bobak <mbobak@cisco.com> on 8.4.2015.
57 public final class HashUtil {
59 private static final Logger LOG = LoggerFactory.getLogger(HashUtil.class);
60 private static final int BASE_16 = 16;
61 private static final int BASE_10 = 10;
62 private static final int IPV6_TOKENS_COUNT = 8;
63 public static final String IPV6_TOKEN = ":0000";
67 throw new IllegalStateException("This class should not be instantiated.");
70 public static int calculateEthernetMatchHash(EthernetMatch ethernetMatch) {
73 EthernetType ethernetType = ethernetMatch.getEthernetType();
74 if (null != ethernetType) {
75 hash += ethernetType.getType().getValue();
78 EthernetDestination ethernetDestination = ethernetMatch.getEthernetDestination();
79 if (null != ethernetDestination) {
80 hash += calculateEthernetDestinationHash(ethernetDestination);
83 EthernetSource ethernetSource = ethernetMatch.getEthernetSource();
84 if (null != ethernetSource) {
85 hash += calculateEthenetSourceHash(ethernetSource);
91 public static int calculateEthenetSourceHash(EthernetSource ethernetSource) {
92 int hash = calculateMacAddressHash(ethernetSource.getAddress());
93 hash += calculateMacAddressHash(ethernetSource.getMask());
97 public static int calculateEthernetDestinationHash(EthernetDestination ethernetDestination) {
98 int hash = calculateMacAddressHash(ethernetDestination.getAddress());
99 hash += calculateMacAddressHash(ethernetDestination.getMask());
103 public static int calculateMacAddressHash(MacAddress macAddress) {
106 if (null != macAddress) {
107 StringTokenizer stringTokenizer = new StringTokenizer(macAddress.getValue(), ":");
108 hash = parseTokens(stringTokenizer, BASE_16);
110 LOG.trace("Calculated hash {} for mac {}", hash, macAddress);
114 public static int calculateMatchHash(final Match match, DeviceContext deviceContext) {
119 if (null != match.getEthernetMatch()) {
121 subHash += calculateEthernetMatchHash(match.getEthernetMatch());
124 if (null != match.getIcmpv4Match()) {
126 subHash += calculateIcmpV4MatchHash(match.getIcmpv4Match());
129 if (null != match.getIcmpv6Match()) {
131 subHash += calculateIcmpV6MatchHash(match.getIcmpv6Match());
134 if (null != match.getInPhyPort()) {
136 subHash += calculateNodeConnectorIdHash(match.getInPhyPort(), deviceContext);
139 if (null != match.getInPort()) {
141 subHash += calculateNodeConnectorIdHash(match.getInPort(), deviceContext);
144 if (null != match.getIpMatch()) {
146 subHash += calculateIpMatchHash(match.getIpMatch());
149 if (null != match.getLayer3Match()) {
151 subHash += calculateLayer3MatchHash(match.getLayer3Match());
154 if (null != match.getLayer4Match()) {
156 subHash += calculateLayer4MatchHash(match.getLayer4Match());
159 if (null != match.getIcmpv6Match()) {
161 subHash += calculateIcmpv6MatchHash(match.getIcmpv6Match());
164 if (null != match.getMetadata()) {
166 subHash += calculateMetadataHash(match.getMetadata());
169 if (null != match.getProtocolMatchFields()) {
171 subHash += calculateProtocolMatchFieldsHash(match.getProtocolMatchFields());
174 if (null != match.getTcpFlagMatch()) {
176 subHash += calculateTcpFlagMatch(match.getTcpFlagMatch());
179 if (null != match.getVlanMatch()) {
181 subHash += calculateVlanMatchHash(match.getVlanMatch());
184 if (null != match.getTunnel()) {
186 subHash += calculateTunnelHash(match.getTunnel());
189 return hash + subHash;
192 private static int calculateTunnelHash(final Tunnel tunnel) {
194 BigInteger tunnelId = tunnel.getTunnelId();
195 if (null != tunnelId) {
196 hash += tunnelId.intValue();
199 BigInteger tunnelMask = tunnel.getTunnelMask();
200 if (null != tunnelMask) {
201 hash += tunnelMask.intValue();
206 private static int calculateVlanMatchHash(final VlanMatch vlanMatch) {
209 VlanId vlanId = vlanMatch.getVlanId();
210 if (null != vlanId) {
211 hash += vlanId.getVlanId().getValue().intValue();
214 VlanPcp vlanPcp = vlanMatch.getVlanPcp();
215 if (null != vlanPcp) {
216 hash += vlanPcp.getValue().shortValue();
222 private static int calculateTcpFlagMatch(final TcpFlagMatch tcpFlagMatch) {
223 int hash = tcpFlagMatch.getTcpFlag().intValue();
227 private static int calculateProtocolMatchFieldsHash(final ProtocolMatchFields protocolMatchFields) {
229 Short mplsBos = protocolMatchFields.getMplsBos();
230 if (null != mplsBos) {
231 hash += mplsBos.intValue();
233 Short mplsTc = protocolMatchFields.getMplsTc();
234 if (null != mplsTc) {
235 hash += mplsTc.intValue();
237 Pbb pbb = protocolMatchFields.getPbb();
239 if (null != pbb.getPbbIsid()) {
240 hash += pbb.getPbbIsid().intValue();
242 if (null != pbb.getPbbMask()) {
243 hash += pbb.getPbbMask().intValue();
246 Long mplsLabel = protocolMatchFields.getMplsLabel();
247 if (null != mplsLabel) {
248 hash += mplsLabel.intValue();
253 private static int calculateMetadataHash(final Metadata metadata) {
254 int hash = metadata.getMetadata().intValue();
255 hash += metadata.getMetadataMask().intValue();
259 private static int calculateIcmpv6MatchHash(final Icmpv6Match icmpv6Match) {
260 int hash = icmpv6Match.getIcmpv6Code().intValue();
261 hash += icmpv6Match.getIcmpv6Type().intValue();
265 private static int calculateLayer4MatchHash(final Layer4Match layer4Match) {
267 if (layer4Match instanceof SctpMatch) {
268 hash += calculateSctpMatchHash((SctpMatch) layer4Match);
271 if (layer4Match instanceof TcpMatch) {
272 hash += calculateTcpMatchHash((TcpMatch) layer4Match);
274 if (layer4Match instanceof UdpMatch) {
275 hash += calculateUdpMatchHash((UdpMatch) layer4Match);
280 private static int calculateUdpMatchHash(final UdpMatch layer4Match) {
285 private static int calculateTcpMatchHash(final TcpMatch layer4Match) {
287 PortNumber sourcePort = layer4Match.getTcpSourcePort();
288 if (null != sourcePort) {
289 hash += sourcePort.getValue().intValue();
292 PortNumber destinationPort = layer4Match.getTcpDestinationPort();
293 if (null != destinationPort) {
294 hash += destinationPort.getValue().intValue();
299 private static int calculateSctpMatchHash(final SctpMatch layer4Match) {
302 PortNumber portNumber = layer4Match.getSctpDestinationPort();
303 if (null != portNumber) {
304 hash += portNumber.getValue().intValue();
307 PortNumber sourcePort = layer4Match.getSctpSourcePort();
308 if (null != sourcePort) {
309 hash += sourcePort.getValue().intValue();
314 private static int calculateLayer3MatchHash(final Layer3Match layer3Match) {
316 if (layer3Match instanceof ArpMatch) {
317 hash += calculateArpMatchHash((ArpMatch) layer3Match);
319 if (layer3Match instanceof Ipv4Match) {
320 hash += calculateIpv4MatchHash((Ipv4Match) layer3Match);
322 if (layer3Match instanceof Ipv6Match) {
323 hash += calculateIpv6MatchHash((Ipv6Match) layer3Match);
326 if (layer3Match instanceof TunnelIpv4Match) {
327 hash += calculateTunnelIpv4Hash((TunnelIpv4Match) layer3Match);
332 private static int calculateTunnelIpv4Hash(final TunnelIpv4Match layer3Match) {
333 Ipv4Prefix tunnelIpv4Destination = layer3Match.getTunnelIpv4Destination();
334 int hash = calculateIpv4PrefixHash(tunnelIpv4Destination);
335 Ipv4Prefix tunnelIpv4Source = layer3Match.getTunnelIpv4Source();
336 hash += calculateIpv4PrefixHash(tunnelIpv4Source);
340 private static int calculateIpv6MatchHash(final Ipv6Match layer3Match) {
342 Ipv6Prefix ipv6Destination = layer3Match.getIpv6Destination();
343 if (null != ipv6Destination) {
344 hash += calculateIpv6PrefixHash(ipv6Destination);
347 if (null != layer3Match.getIpv6Source()) {
348 hash += calculateIpv6PrefixHash(layer3Match.getIpv6Source());
351 if (null != layer3Match.getIpv6ExtHeader()) {
352 hash += layer3Match.getIpv6ExtHeader().getIpv6Exthdr();
353 hash += layer3Match.getIpv6ExtHeader().getIpv6ExthdrMask();
356 if (null != layer3Match.getIpv6NdSll()) {
357 hash += calculateMacAddressHash(layer3Match.getIpv6NdSll());
359 if (null != layer3Match.getIpv6NdTll()) {
360 hash += calculateMacAddressHash(layer3Match.getIpv6NdTll());
362 if (null != layer3Match.getIpv6NdTarget()){
363 hash += calculateIpv6AddressHash(layer3Match.getIpv6NdTarget());
369 public static int calculateIpv6PrefixHash(final Ipv6Prefix ipv6Prefix) {
371 StringTokenizer stringTokenizer = getStringTokenizerWithFullAddressString(ipv6Prefix.getValue());
373 int hash = parseTokens(stringTokenizer, BASE_16);
376 public static int calculateIpv6AddressHash(final Ipv6Address ipv6Address) {
378 StringTokenizer stringTokenizer = getStringTokenizerWithFullAddressString(ipv6Address.getValue());
380 int hash = parseTokens(stringTokenizer, BASE_16);
384 private static StringTokenizer getStringTokenizerWithFullAddressString(String value) {
385 String ipv6Value = value.replace("::", ":0000:");
386 StringTokenizer stringTokenizer = new StringTokenizer(ipv6Value, ":");
388 int delta = IPV6_TOKENS_COUNT - stringTokenizer.countTokens();
390 StringBuffer additions = new StringBuffer();
394 additions.append(IPV6_TOKEN);
397 if (ipv6Value.contains("/")) {
398 ipv6Value = ipv6Value.replace("/", additions.toString() + "/");
400 ipv6Value += additions.toString();
402 stringTokenizer = new StringTokenizer(ipv6Value, ":");
404 return stringTokenizer;
407 private static int calculateStopperBasedOnMaskValue(final Ipv6Prefix ipv6Prefix, int bitsBase) {
408 double maskValue = extractMask(ipv6Prefix);
409 double bitCount = maskValue / bitsBase;
410 return (int) Math.ceil(bitCount);
413 private static int extractMask(final Ipv6Prefix ipv6Prefix) {
414 StringTokenizer maskTokenizer = new StringTokenizer(ipv6Prefix.getValue(), "/");
415 maskTokenizer.nextToken();
416 int mask = Integer.parseInt(maskTokenizer.nextToken());
420 private static int parseTokens(final StringTokenizer stringTokenizer, int base) {
421 return parseTokens(stringTokenizer, 0, base);
424 private static int parseTokens(final StringTokenizer stringTokenizer, int stopper, int base) {
426 if (stringTokenizer.countTokens() > 0) {
428 while (stringTokenizer.hasMoreTokens()) {
429 String token = stringTokenizer.nextToken();
432 if (token.equals("")) {
436 if (token.contains("/")) {
437 StringTokenizer tokenizer = new StringTokenizer(token, "/");
438 hash = hash ^ parseTokens(tokenizer, stopper, base);
440 hash = hash ^ ((Integer.parseInt(token, base) * step) + step);
441 if (stopper > 0 && step == stopper) {
450 private static int calculateIpv4MatchHash(final Ipv4Match layer3Match) {
452 Ipv4Prefix ipv4Destination = layer3Match.getIpv4Destination();
453 if (null != ipv4Destination) {
454 hash += calculateIpv4PrefixHash(ipv4Destination);
457 Ipv4Prefix ipv4Source = layer3Match.getIpv4Source();
459 if (null != ipv4Source) {
460 hash += calculateIpv4PrefixHash(ipv4Source);
463 //TODO : add calculation of hashes for augmentations
467 private static int calculateArpMatchHash(final ArpMatch layer3Match) {
469 Integer arpOp = layer3Match.getArpOp();
471 hash += arpOp.intValue();
473 ArpSourceHardwareAddress arpSourceHardwareAddress = layer3Match.getArpSourceHardwareAddress();
474 if (null != arpSourceHardwareAddress) {
475 hash += calculateMacAddressHash(arpSourceHardwareAddress.getAddress());
476 hash += calculateMacAddressHash(arpSourceHardwareAddress.getMask());
479 Ipv4Prefix sourceTransportAddress = layer3Match.getArpSourceTransportAddress();
480 if (null != sourceTransportAddress) {
481 hash += calculateIpv4PrefixHash(sourceTransportAddress);
484 ArpTargetHardwareAddress arpTargetHardwareAddress = layer3Match.getArpTargetHardwareAddress();
485 if (null != arpTargetHardwareAddress) {
486 hash += calculateMacAddressHash(arpTargetHardwareAddress.getAddress());
487 hash += calculateMacAddressHash(arpTargetHardwareAddress.getMask());
490 Ipv4Prefix targetTransportAddress = layer3Match.getArpTargetTransportAddress();
491 if (null != targetTransportAddress) {
492 hash += calculateIpv4PrefixHash(targetTransportAddress);
498 public static int calculateIpv4PrefixHash(final Ipv4Prefix ipv4Prefix) {
500 StringTokenizer prefixAsArray = new StringTokenizer(ipv4Prefix.getValue(), "/");
501 if (prefixAsArray.countTokens() == 2) {
502 String address = prefixAsArray.nextToken();
503 Integer mask = Integer.parseInt(prefixAsArray.nextToken());
504 int numberOfAddressPartsToUse = (int) Math.ceil(mask.doubleValue() / 8);
505 hash += calculateIpAdressHash(address, numberOfAddressPartsToUse, BASE_10);
506 hash += mask.shortValue();
512 private static int calculateIpAdressHash(final String address, int numberOfParts, int base) {
513 StringTokenizer stringTokenizer = new StringTokenizer(address, ".");
514 int hash = parseTokens(stringTokenizer, numberOfParts, base);
518 private static int calculateIpMatchHash(final IpMatch ipMatch) {
520 Short ipEcn = ipMatch.getIpEcn();
522 hash += ipEcn.shortValue();
524 Short ipProtocol = ipMatch.getIpProtocol();
525 if (null != ipProtocol) {
529 Short ipDscp = ipMatch.getIpDscp().getValue();
530 if (null != ipDscp) {
534 IpVersion ipVersion = ipMatch.getIpProto();
535 if (null != ipVersion) {
536 hash += ipVersion.getIntValue();
541 private static int calculateNodeConnectorIdHash(final NodeConnectorId inPhyPort, DeviceContext deviceContext) {
543 short version = deviceContext.getDeviceState().getVersion();
544 Long portFromLogicalName = OpenflowPortsUtil.getPortFromLogicalName(OpenflowVersion.get(version), inPhyPort.getValue());
545 hash += portFromLogicalName.intValue();
549 private static int calculateIcmpV6MatchHash(final Icmpv6Match icmpv6Match) {
551 if (null != icmpv6Match.getIcmpv6Code()) {
552 hash += icmpv6Match.getIcmpv6Code();
554 if (null != icmpv6Match.getIcmpv6Type()) {
555 hash += icmpv6Match.getIcmpv6Type();
560 public static int calculateIcmpV4MatchHash(final Icmpv4Match icmpv4Match) {
562 if (null != icmpv4Match.getIcmpv4Code()) {
563 hash += icmpv4Match.getIcmpv4Code();
565 if (null != icmpv4Match.getIcmpv4Type()) {
566 hash += icmpv4Match.getIcmpv4Type();