ONOS-508: Implement IPv6, ICMP6 and NeighborAdvertisement class

Create ICMP6 class, which is mostly like ICMP

Change-Id: I11d7abec4a8f1fd202e5dfb0a500f621773c2c3a

Create IPv6 class, which is mostly like IPv4

Change-Id: I7a301a0f94263df5d6d30f73050332ec7acfe611

Register handler class of IPv6 to Ethernet

Change-Id: Iccdef1680664520f9d66360a289809710982ce54

Fix FIXED_HEADER_LENGTH

Change-Id: Iff4fb22638416595f2865ff46b682a0579ba33d5

Fix payloadLength

Change-Id: I8dea4dd52f0bb5926fbff0d9e74fdd19404cabff

Add unittest for serialize

Change-Id: If194aa2530ce517a33b36b97b8478b0a4c463954

Add unittest for deserialize. Fix assertArrayEquals. Refine test structure.

Change-Id: I94f2a348b2be2f5907d8bac6b9029b37eb31456d

Payload length should be handled during serializing/deserializing procedure

Change-Id: Ib079bf939a01a38356c824ed972793293ed8ca1e

Add unittest for comparator

Change-Id: I937dd9330d7c23a81ecd8434ac0fcf7345cc5c00

Fix typo. Fix checkstyle error

Change-Id: I2fe1af81c65416b0fddaa0fb9ae206b87b889628

Add implementation and unittest for NeighborAdvertisement

Change-Id: I7610462a5712f9fee5be0416c08e1de302e0780d

Register handler class of NeighborAdvertisement to ICMP6

Change-Id: I3a7a9cf044cfdcd8908579942c159c2f0aad198d
diff --git a/utils/misc/src/main/java/org/onlab/packet/IPv6.java b/utils/misc/src/main/java/org/onlab/packet/IPv6.java
new file mode 100644
index 0000000..aec3c2a
--- /dev/null
+++ b/utils/misc/src/main/java/org/onlab/packet/IPv6.java
@@ -0,0 +1,311 @@
+/*
+ * Copyright 2014 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+
+package org.onlab.packet;
+
+import java.nio.ByteBuffer;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ *
+ */
+public class IPv6 extends BasePacket {
+    public static final byte FIXED_HEADER_LENGTH = 40; // bytes
+
+    // TODO: Implement extension header.
+    public static final byte PROTOCOL_TCP = 0x6;
+    public static final byte PROTOCOL_UDP = 0x11;
+    public static final byte PROTOCOL_ICMP6 = 0x3A;
+    public static final Map<Byte, Class<? extends IPacket>> PROTOCOL_CLASS_MAP =
+            new HashMap<>();
+
+    static {
+        IPv6.PROTOCOL_CLASS_MAP.put(IPv6.PROTOCOL_ICMP6, ICMP6.class);
+        IPv6.PROTOCOL_CLASS_MAP.put(IPv6.PROTOCOL_TCP, TCP.class);
+        IPv6.PROTOCOL_CLASS_MAP.put(IPv6.PROTOCOL_UDP, UDP.class);
+    }
+
+    protected byte version;
+    protected byte diffServ;
+    protected int flowLabel;
+    protected short payloadLength;
+    protected byte nextHeader;
+    protected byte hopLimit;
+    protected byte[] sourceAddress = new byte[Ip6Address.BYTE_LENGTH];
+    protected byte[] destinationAddress = new byte[Ip6Address.BYTE_LENGTH];
+
+    /**
+     * Default constructor that sets the version to 4.
+     */
+    public IPv6() {
+        super();
+        this.version = 6;
+    }
+
+    /**
+     * @return the version
+     */
+    public byte getVersion() {
+        return this.version;
+    }
+
+    /**
+     * @param version
+     *            the version to set
+     * @return this
+     */
+    public IPv6 setVersion(final byte version) {
+        this.version = version;
+        return this;
+    }
+
+    /**
+     * @return the diffServ
+     */
+    public byte getDiffServ() {
+        return this.diffServ;
+    }
+
+    /**
+     * @param diffServ
+     *            the diffServ to set
+     * @return this
+     */
+    public IPv6 setDiffServ(final byte diffServ) {
+        this.diffServ = diffServ;
+        return this;
+    }
+
+    /**
+     * @return the flowLabel
+     */
+    public int getFlowLabel() {
+        return this.flowLabel;
+    }
+
+    /**
+     * @param flowLabel
+     *            the flowLabel to set
+     * @return this
+     */
+    public IPv6 setFlowLabel(final int flowLabel) {
+        this.flowLabel = flowLabel;
+        return this;
+    }
+
+    /**
+     * @return the nextHeader
+     */
+    public byte getNextHeader() {
+        return this.nextHeader;
+    }
+
+    /**
+     * @param nextHeader
+     *            the nextHeader to set
+     * @return this
+     */
+    public IPv6 setNextHeader(final byte nextHeader) {
+        this.nextHeader = nextHeader;
+        return this;
+    }
+
+    /**
+     * @return the hopLimit
+     */
+    public byte getHopLimit() {
+        return this.hopLimit;
+    }
+
+    /**
+     * @param hopLimit
+     *            the hopLimit to set
+     * @return this
+     */
+    public IPv6 setHopLimit(final byte hopLimit) {
+        this.hopLimit = hopLimit;
+        return this;
+    }
+
+    /**
+     * @return the sourceAddress
+     */
+    public byte[] getSourceAddress() {
+        return this.sourceAddress;
+    }
+
+    /**
+     * @param sourceAddress
+     *            the sourceAddress to set
+     * @return this
+     */
+    public IPv6 setSourceAddress(final byte[] sourceAddress) {
+        this.sourceAddress = Arrays.copyOfRange(sourceAddress, 0, Ip6Address.BYTE_LENGTH);
+        return this;
+    }
+
+    /**
+     * @return the destinationAddress
+     */
+    public byte[] getDestinationAddress() {
+        return this.destinationAddress;
+    }
+
+    /**
+     * @param destinationAddress
+     *            the destinationAddress to set
+     * @return this
+     */
+    public IPv6 setDestinationAddress(final byte[] destinationAddress) {
+        this.destinationAddress = Arrays.copyOfRange(destinationAddress, 0, Ip6Address.BYTE_LENGTH);
+        return this;
+    }
+
+    @Override
+    public byte[] serialize() {
+        byte[] payloadData = null;
+        if (this.payload != null) {
+            this.payload.setParent(this);
+            payloadData = this.payload.serialize();
+        }
+
+        this.payloadLength = payloadData == null ? 0 : (short) payloadData.length;
+
+        final byte[] data = new byte[FIXED_HEADER_LENGTH + payloadLength];
+        final ByteBuffer bb = ByteBuffer.wrap(data);
+
+        bb.putInt((this.version & 0xf) << 28 | (this.diffServ & 0xff) << 20 | this.flowLabel & 0xfffff);
+        bb.putShort(this.payloadLength);
+        bb.put(this.nextHeader);
+        bb.put(this.hopLimit);
+        bb.put(this.sourceAddress, 0, Ip6Address.BYTE_LENGTH);
+        bb.put(this.destinationAddress, 0, Ip6Address.BYTE_LENGTH);
+
+        if (payloadData != null) {
+            bb.put(payloadData);
+        }
+
+        return data;
+    }
+
+    @Override
+    public IPacket deserialize(final byte[] data, final int offset,
+                               final int length) {
+        final ByteBuffer bb = ByteBuffer.wrap(data, offset, length);
+        int iscratch;
+
+        iscratch = bb.getInt();
+        this.version = (byte) (iscratch >> 28 & 0xf);
+        this.diffServ = (byte) (iscratch >> 20 & 0xff);
+        this.flowLabel = iscratch & 0xfffff;
+        this.payloadLength = bb.getShort();
+        this.nextHeader = bb.get();
+        this.hopLimit = bb.get();
+        bb.get(this.sourceAddress, 0, Ip6Address.BYTE_LENGTH);
+        bb.get(this.destinationAddress, 0, Ip6Address.BYTE_LENGTH);
+
+        IPacket payload;
+        if (IPv6.PROTOCOL_CLASS_MAP.containsKey(this.nextHeader)) {
+            final Class<? extends IPacket> clazz = IPv6.PROTOCOL_CLASS_MAP
+                    .get(this.nextHeader);
+            try {
+                payload = clazz.newInstance();
+            } catch (final Exception e) {
+                throw new RuntimeException(
+                        "Error parsing payload for IPv6 packet", e);
+            }
+        } else {
+            payload = new Data();
+        }
+        this.payload = payload.deserialize(data, bb.position(),
+                bb.limit() - bb.position());
+        this.payload.setParent(this);
+
+        return this;
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see java.lang.Object#hashCode()
+     */
+    @Override
+    public int hashCode() {
+        final int prime = 2521;
+        int result = super.hashCode();
+        ByteBuffer bb;
+        bb = ByteBuffer.wrap(this.destinationAddress);
+        for (int i = 0; i < 4; i++) {
+            result = prime * result + bb.getInt();
+        }
+        result = prime * result + this.diffServ;
+        result = prime * result + this.flowLabel;
+        result = prime * result + this.hopLimit;
+        result = prime * result + this.nextHeader;
+        result = prime * result + this.payloadLength;
+        bb = ByteBuffer.wrap(this.sourceAddress);
+        for (int i = 0; i < 4; i++) {
+            result = prime * result + bb.getInt();
+        }
+        result = prime * result + this.version;
+        return result;
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see java.lang.Object#equals(java.lang.Object)
+     */
+    @Override
+    public boolean equals(final Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (!super.equals(obj)) {
+            return false;
+        }
+        if (!(obj instanceof IPv6)) {
+            return false;
+        }
+        final IPv6 other = (IPv6) obj;
+        if (!Arrays.equals(this.destinationAddress, other.destinationAddress)) {
+            return false;
+        }
+        if (this.diffServ != other.diffServ) {
+            return false;
+        }
+        if (this.flowLabel != other.flowLabel) {
+            return false;
+        }
+        if (this.hopLimit != other.hopLimit) {
+            return false;
+        }
+        if (this.nextHeader != other.nextHeader) {
+            return false;
+        }
+        if (this.payloadLength != other.payloadLength) {
+            return false;
+        }
+        if (!Arrays.equals(this.sourceAddress, other.sourceAddress)) {
+            return false;
+        }
+        return true;
+    }
+}