org.onlab.packet.ipv6.Fragment Maven / Gradle / Ivy
/*
* Copyright 2015-present Open Networking Foundation
*
* 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.ipv6;
import org.onlab.packet.BasePacket;
import org.onlab.packet.Data;
import org.onlab.packet.Deserializer;
import org.onlab.packet.IPacket;
import org.onlab.packet.IPv6;
import java.nio.ByteBuffer;
import static com.google.common.base.MoreObjects.toStringHelper;
import static org.onlab.packet.PacketUtils.checkInput;
/**
* Implements IPv6 fragment extension header format. (RFC 2460)
*/
public class Fragment extends BasePacket implements IExtensionHeader {
public static final byte HEADER_LENGTH = 8; // bytes
protected byte nextHeader;
protected short fragmentOffset;
protected byte moreFragment;
protected int identification;
@Override
public byte getNextHeader() {
return this.nextHeader;
}
@Override
public Fragment setNextHeader(final byte nextHeader) {
this.nextHeader = nextHeader;
return this;
}
/**
* Gets the fragment offset of this header.
*
* @return fragment offset
*/
public short getFragmentOffset() {
return this.fragmentOffset;
}
/**
* Sets the fragment offset of this header.
*
* @param fragmentOffset the fragment offset to set
* @return this
*/
public Fragment setFragmentOffset(final short fragmentOffset) {
this.fragmentOffset = fragmentOffset;
return this;
}
/**
* Gets the more fragment flag of this header.
*
* @return more fragment flag
*/
public byte getMoreFragment() {
return this.moreFragment;
}
/**
* Sets the more fragment flag of this header.
*
* @param moreFragment the more fragment flag to set
* @return this
*/
public Fragment setMoreFragment(final byte moreFragment) {
this.moreFragment = moreFragment;
return this;
}
/**
* Gets the identification of this header.
*
* @return identification
*/
public int getIdentification() {
return this.identification;
}
/**
* Sets the identification of this header.
*
* @param identification the identification to set
* @return this
*/
public Fragment setIdentification(final int identification) {
this.identification = identification;
return this;
}
@Override
public byte[] serialize() {
byte[] payloadData = null;
if (this.payload != null) {
this.payload.setParent(this);
payloadData = this.payload.serialize();
}
int payloadLength = 0;
if (payloadData != null) {
payloadLength = payloadData.length;
}
final byte[] data = new byte[HEADER_LENGTH + payloadLength];
final ByteBuffer bb = ByteBuffer.wrap(data);
bb.put(this.nextHeader);
bb.put((byte) 0);
bb.putShort((short) (
(this.fragmentOffset & 0x1fff) << 3 |
this.moreFragment & 0x1
));
bb.putInt(this.identification);
if (payloadData != null) {
bb.put(payloadData);
}
if (this.parent != null && this.parent instanceof IExtensionHeader) {
((IExtensionHeader) this.parent).setNextHeader(IPv6.PROTOCOL_FRAG);
}
return data;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
final int prime = 5807;
int result = super.hashCode();
result = prime * result + this.nextHeader;
result = prime * result + this.fragmentOffset;
result = prime * result + this.moreFragment;
result = prime * result + this.identification;
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 Fragment)) {
return false;
}
final Fragment other = (Fragment) obj;
if (this.nextHeader != other.nextHeader) {
return false;
}
if (this.fragmentOffset != other.fragmentOffset) {
return false;
}
if (this.moreFragment != other.moreFragment) {
return false;
}
if (this.identification != other.identification) {
return false;
}
return true;
}
/**
* Deserializer function for fragment headers.
*
* @return deserializer function
*/
public static Deserializer deserializer() {
return (data, offset, length) -> {
checkInput(data, offset, length, HEADER_LENGTH);
Fragment fragment = new Fragment();
ByteBuffer bb = ByteBuffer.wrap(data, offset, length);
fragment.nextHeader = bb.get();
bb.get();
short sscratch = bb.getShort();
fragment.fragmentOffset = (short) (sscratch >> 3 & 0x1fff);
fragment.moreFragment = (byte) (sscratch & 0x1);
fragment.identification = bb.getInt();
Deserializer deserializer;
if (IPv6.PROTOCOL_DESERIALIZER_MAP.containsKey(fragment.nextHeader)) {
deserializer = IPv6.PROTOCOL_DESERIALIZER_MAP.get(fragment.nextHeader);
} else {
deserializer = Data.deserializer();
}
fragment.payload = deserializer.deserialize(data, bb.position(),
bb.limit() - bb.position());
fragment.payload.setParent(fragment);
return fragment;
};
}
@Override
public String toString() {
return toStringHelper(getClass())
.add("nextHeader", Byte.toString(nextHeader))
.add("fragmentOffset", Short.toString(fragmentOffset))
.add("moreFragment", Byte.toString(moreFragment))
.add("identification", Integer.toString(identification))
.toString();
}
}