From b731e2f1dd0972409b136aebc7b463dd72c9cfad Mon Sep 17 00:00:00 2001 From: CNlucius Date: Tue, 13 Sep 2016 11:40:12 +0800 Subject: ONOSFW-171 O/S-SFC-ONOS scenario documentation Change-Id: I51ae1cf736ea24ab6680f8edca1b2bf5dd598365 Signed-off-by: CNlucius --- .../onlab/packet/ndp/NeighborAdvertisement.java | 278 ------------------ .../onlab/packet/ndp/NeighborDiscoveryOptions.java | 281 ------------------ .../org/onlab/packet/ndp/NeighborSolicitation.java | 192 ------------ .../main/java/org/onlab/packet/ndp/Redirect.java | 225 -------------- .../org/onlab/packet/ndp/RouterAdvertisement.java | 325 --------------------- .../org/onlab/packet/ndp/RouterSolicitation.java | 155 ---------- .../java/org/onlab/packet/ndp/package-info.java | 21 -- 7 files changed, 1477 deletions(-) delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborAdvertisement.java delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborDiscoveryOptions.java delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborSolicitation.java delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/Redirect.java delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/RouterAdvertisement.java delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/RouterSolicitation.java delete mode 100644 framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/package-info.java (limited to 'framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp') diff --git a/framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborAdvertisement.java b/framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborAdvertisement.java deleted file mode 100644 index 99fa0dd6..00000000 --- a/framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborAdvertisement.java +++ /dev/null @@ -1,278 +0,0 @@ -/* - * Copyright 2014-2015 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.ndp; - -import org.onlab.packet.BasePacket; -import org.onlab.packet.Deserializer; -import org.onlab.packet.IPacket; -import org.onlab.packet.Ip6Address; - -import java.nio.ByteBuffer; -import java.util.Arrays; -import java.util.List; - -import static org.onlab.packet.PacketUtils.checkInput; - -/** - * Implements ICMPv6 Neighbor Advertisement packet format (RFC 4861). - */ -public class NeighborAdvertisement extends BasePacket { - public static final byte HEADER_LENGTH = 20; // bytes - - protected byte routerFlag; - protected byte solicitedFlag; - protected byte overrideFlag; - protected byte[] targetAddress = new byte[Ip6Address.BYTE_LENGTH]; - - private final NeighborDiscoveryOptions options = - new NeighborDiscoveryOptions(); - - /** - * Gets router flag. - * - * @return the router flag - */ - public byte getRouterFlag() { - return this.routerFlag; - } - - /** - * Sets router flag. - * - * @param routerFlag the router flag to set - * @return this - */ - public NeighborAdvertisement setRouterFlag(final byte routerFlag) { - this.routerFlag = routerFlag; - return this; - } - - /** - * Gets solicited flag. - * - * @return the solicited flag - */ - public byte getSolicitedFlag() { - return this.solicitedFlag; - } - - /** - * Sets solicited flag. - * - * @param solicitedFlag the solicited flag to set - * @return this - */ - public NeighborAdvertisement setSolicitedFlag(final byte solicitedFlag) { - this.solicitedFlag = solicitedFlag; - return this; - } - - /** - * Gets override flag. - * - * @return the override flag - */ - public byte getOverrideFlag() { - return this.overrideFlag; - } - - /** - * Sets override flag. - * - * @param overrideFlag the override flag to set - * @return this - */ - public NeighborAdvertisement setOverrideFlag(final byte overrideFlag) { - this.overrideFlag = overrideFlag; - return this; - } - - /** - * Gets target address. - * - * @return the target IPv6 address - */ - public byte[] getTargetAddress() { - return this.targetAddress; - } - - /** - * Sets target address. - * - * @param targetAddress the target IPv6 address to set - * @return this - */ - public NeighborAdvertisement setTargetAddress(final byte[] targetAddress) { - this.targetAddress = - Arrays.copyOfRange(targetAddress, 0, Ip6Address.BYTE_LENGTH); - return this; - } - - /** - * Gets the Neighbor Discovery Protocol packet options. - * - * @return the Neighbor Discovery Protocol packet options - */ - public List getOptions() { - return this.options.options(); - } - - /** - * Adds a Neighbor Discovery Protocol packet option. - * - * @param type the option type - * @param data the option data - * @return this - */ - public NeighborAdvertisement addOption(final byte type, - final byte[] data) { - this.options.addOption(type, data); - return this; - } - - @Override - public byte[] serialize() { - byte[] optionsData = null; - if (this.options.hasOptions()) { - optionsData = this.options.serialize(); - } - - int optionsLength = 0; - if (optionsData != null) { - optionsLength = optionsData.length; - } - - final byte[] data = new byte[HEADER_LENGTH + optionsLength]; - final ByteBuffer bb = ByteBuffer.wrap(data); - - bb.putInt((this.routerFlag & 0x1) << 31 | - (this.solicitedFlag & 0x1) << 30 | - (this.overrideFlag & 0x1) << 29); - bb.put(this.targetAddress, 0, Ip6Address.BYTE_LENGTH); - if (optionsData != null) { - bb.put(optionsData); - } - - return data; - } - - @Override - public IPacket deserialize(byte[] data, int offset, int length) { - final ByteBuffer bb = ByteBuffer.wrap(data, offset, length); - int iscratch; - - iscratch = bb.getInt(); - this.routerFlag = (byte) (iscratch >> 31 & 0x1); - this.solicitedFlag = (byte) (iscratch >> 30 & 0x1); - this.overrideFlag = (byte) (iscratch >> 29 & 0x1); - bb.get(this.targetAddress, 0, Ip6Address.BYTE_LENGTH); - - this.options.deserialize(data, bb.position(), - bb.limit() - bb.position()); - - return this; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - final int prime = 5807; - int result = super.hashCode(); - ByteBuffer bb; - result = prime * result + this.routerFlag; - result = prime * result + this.solicitedFlag; - result = prime * result + this.overrideFlag; - bb = ByteBuffer.wrap(this.targetAddress); - for (int i = 0; i < this.targetAddress.length / 4; i++) { - result = prime * result + bb.getInt(); - } - result = prime * result + this.options.hashCode(); - 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 NeighborAdvertisement)) { - return false; - } - final NeighborAdvertisement other = (NeighborAdvertisement) obj; - if (this.routerFlag != other.routerFlag) { - return false; - } - if (this.solicitedFlag != other.solicitedFlag) { - return false; - } - if (this.overrideFlag != other.overrideFlag) { - return false; - } - if (!Arrays.equals(this.targetAddress, other.targetAddress)) { - return false; - } - if (!this.options.equals(other.options)) { - return false; - } - return true; - } - - /** - * Deserializer function for neighbor advertisement packets. - * - * @return deserializer function - */ - public static Deserializer deserializer() { - return (data, offset, length) -> { - checkInput(data, offset, length, HEADER_LENGTH); - - NeighborAdvertisement neighborAdvertisement = new NeighborAdvertisement(); - - ByteBuffer bb = ByteBuffer.wrap(data, offset, length); - - int iscratch; - - iscratch = bb.getInt(); - neighborAdvertisement.routerFlag = (byte) (iscratch >> 31 & 0x1); - neighborAdvertisement.solicitedFlag = (byte) (iscratch >> 30 & 0x1); - neighborAdvertisement.overrideFlag = (byte) (iscratch >> 29 & 0x1); - bb.get(neighborAdvertisement.targetAddress, 0, Ip6Address.BYTE_LENGTH); - - if (bb.limit() - bb.position() > 0) { - NeighborDiscoveryOptions options = NeighborDiscoveryOptions.deserializer() - .deserialize(data, bb.position(), bb.limit() - bb.position()); - - for (NeighborDiscoveryOptions.Option option : options.options()) { - neighborAdvertisement.addOption(option.type(), option.data()); - } - } - - return neighborAdvertisement; - }; - } -} diff --git a/framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborDiscoveryOptions.java b/framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborDiscoveryOptions.java deleted file mode 100644 index 00a26068..00000000 --- a/framework/src/onos/utils/misc/src/main/java/org/onlab/packet/ndp/NeighborDiscoveryOptions.java +++ /dev/null @@ -1,281 +0,0 @@ -/* - * Copyright 2015 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.ndp; - -import org.onlab.packet.BasePacket; -import org.onlab.packet.DeserializationException; -import org.onlab.packet.Deserializer; -import org.onlab.packet.IPacket; - -import java.nio.ByteBuffer; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -import static org.onlab.packet.PacketUtils.checkInput; - -/** - * Neighbor Discovery Protocol packet options. - */ -public class NeighborDiscoveryOptions extends BasePacket { - public static final byte TYPE_SOURCE_LL_ADDRESS = 1; - public static final byte TYPE_TARGET_LL_ADDRESS = 2; - public static final byte TYPE_PREFIX_INFORMATION = 3; - public static final byte TYPE_REDIRECTED_HEADER = 4; - public static final byte TYPE_MTU = 5; - - public static final byte INITIAL_HEADER_REQUIRED = 2; - - private static final String BUFFER_UNDERFLOW_ERROR = - "Not enough bytes in buffer to read option"; - - private final List