#!/usr/bin/perl
#
# $Name: V6LC_4_0_1 $
#
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
# 	Yokogawa Electric Corporation.
# All rights reserved.
# 
# Redistribution and use of this software in source and binary
# forms, with or without modification, are permitted provided that
# the following conditions and disclaimer are agreed and accepted
# by the user:
# 
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with
#    the distribution.
# 
# 3. Neither the names of the copyrighters, the name of the project
#    which is related to this software (hereinafter referred to as
#    "project") nor the names of the contributors may be used to
#    endorse or promote products derived from this software without
#    specific prior written permission.
# 
# 4. No merchantable use may be permitted without prior written
#    notification to the copyrighters.
# 
# 5. The copyrighters, the project and the contributors may prohibit
#    the use of this software at any time.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHTERS, THE PROJECT AND
# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING
# BUT NOT LIMITED THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.  IN NO EVENT SHALL THE
# COPYRIGHTERS, THE PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# $Id: F_Reassembly_Valid.seq,v 1.4 2005/04/11 08:27:20 akisada Exp $
#
######################################################################
BEGIN {
	$V6evalTool::TestVersion = '$Name: V6LC_4_0_1 $';
}

use V6evalTool;
use CommonSPEC;

$discard_te = $CommonSPEC::exceed_max;

$pktdesc{'echo_request_1st'}	= 'Send Echo Request (1st fragment)';
$pktdesc{'echo_request_2nd'}	= 'Send Echo Request (2nd fragment)';
$pktdesc{'echo_request_3rd'}	= 'Send Echo Request (3rd fragment)';
$pktdesc{'echo_reply'}		= 'Recv Echo Reply';

$endStatus = $V6evalTool::exitPass;

#----- create Fragment ID
$id = time & 0x00000fff;
$fid = sprintf("0x0%07x", $id);
$rid = sprintf("0x0%03x", $id);
$sno = 0;

vCPP("-DFRAG_ID=$fid -DREQ_ID=$rid -DSEQ_NO=$sno");
################################################################
$IF = 'Link0';

vCapture($IF);

#----- test
vSend($IF, 'echo_request_1st');
vSend($IF, 'echo_request_2nd');
vSend($IF, 'echo_request_3rd');
%ret = nd_vRecv_EN($IF, $CommonSPEC::wait_reply, 0, 0, 'echo_reply');

if ($ret{'status'} == 0) {
	vLogHTML('OK<BR>');
} else {
	vLogHTML('Cannot received Echo Reply<BR>');
	vLogHTML('<FONT COLOR="#FF0000">NG</FONT><BR>');
	vSleep($discard_te, "Discard Unexpected 'ICMP Time Exceeded' message ($discard_te sec)");
	$endStatus = $V6evalTool::exitFail;
}
#----- end test

$ret = cleanup($IF);
vStop($IF);
if ($ret == $CommonSPEC::Success) {
	exit($endStatus);
} else {
	exit($V6evalTool::exitFatal);
}


######################################################################
__END__

=head1 NAME

  F_Reassembly_Valid - Fragment Reassembly (All Fragments are Valid)

=head1 TARGET

  Host and Router

=head1 SYNOPSIS

=begin html
<PRE>
  <A HREF="./F_Reassembly_Valid.seq">F_Reassembly_Valid.seq</A> [-tooloption ...] -pkt <A HREF="./F_Reassembly_Valid.def">F_Reassembly_Valid.def</A>
    -tooloption : v6eval tool option
</PRE>

=end html

=head1 INITIALIZATION

  None

=head1 TEST PROCEDURE

  Tester                      Target
    |                           |
    |-------------------------->|
    |   Echo Request (1st)      |
    |                           |
    |-------------------------->|
    |   Echo Request (2nd)      |
    |                           |
    |-------------------------->|
    |   Echo Request (3rd)      |
    |                           |
    |<--------------------------|
    |   Neighbor Solicitation   |
    |                           |
    |-------------------------->|
    |   Neighbor Advertisement  |
    |                           |
    |<--------------------------|
    |   Echo Reply              |
    |                           |
    |                           |
    v                           v


  1. Send Echo Request (1st fragment)
  2. Send Echo Request (2nd fragment)
  3. Send Echo Request (3rd fragment)
  4. Wait Echo Reply or NS
  5. If NS received then send NA, and wait Echo Reply again
  6. Receive Echo Reply

  Echo Request Data (original) is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 88
            NextHeader         = 58 (ICMPv6)
            SourceAddress      = Tester Link Local Address
            DestinationAddress = Target Link Local Address

        ICMP Echo Request
            Type           = 128 (Echo Request)
            Code           = 0
            Checksum       = (auto)
            Identifier     = (auto)
            SequenceNumber = 0
            PayloadData    = data repeat{0x1, 40}
                             data repeat{0x2, 40}

  Echo Request Data (1st fragment) is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 40
            NextHeader         = 44 (Fragment Header)
            SourceAddress      = Tester Link Local Address
            DestinationAddress = Target Link Local Address

        Fragment Header
            NextHeader         = 58 (ICMPv6)
            FragmentOffset     = 0
            MFlag              = 1
            Identification     = 32bit (Automatic generation)

        Payload
            data               = 32 octets from the head of ICMP Echo request

  Echo Request Data (2nd fragment) is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 40
            NextHeader         = 44 (Fragment Header)
            SourceAddress      = Tester Link Local Address
            DestinationAddress = Target Link Local Address

        Fragment Header
            NextHeader         = 58 (ICMPv6)
            FragmentOffset     = 4
            MFlag              = 1
            Identification     = 32bit (Automatic generation)

        Payload
            data               = 32 octets from the back of ICMP Echo request

  Echo Request Data (3rd fragment) is:

        IPv6 Header
            Version            = 6
            Traffic Class      = 0
            FlowLabel          = 0
            PayloadLength      = 32
            NextHeader         = 44 (Fragment Header)
            SourceAddress      = Tester Link Local Address
            DestinationAddress = Target Link Local Address

        Fragment Header
            NextHeader         = 58 (ICMPv6)
            FragmentOffset     = 8
            MFlag              = 0
            Identification     = 32bit (Automatic generation)

        Payload
            data               = 24 octets from the back of ICMP Echo request

=head1 JUDGEMENT

  PASS: Echo Reply Received

        IPv6 Header
            Version             = 6
            Traffic Class       = 0
            FlowLabel           = 0
            PayloadLength       = 88
            NextHeader          = 58 (ICMPv6)
            SourceAddress       = Target Link Local Address
            Destination Address = Tester Link Local Address

        ICMP Echo Reply
            Type           = 129 (Echo Reply)
            Code           = 0
            Checksum       = (auto)
            Identifier     = (same as Echo Request)
            SequenceNumber = (same as Echo Request)
            PayloadData    = (same as Echo Request)

=cut

# =head1 REFERENCE
# 
# RFC2460
# 
# 4.5  Fragment Header
# 
#    The Fragment header is used by an IPv6 source to send a packet larger
#    than would fit in the path MTU to its destination.  (Note: unlike
#    IPv4, fragmentation in IPv6 is performed only by source nodes, not by
#    routers along a packet's delivery path -- see section 5.)  The
#    Fragment header is identified by a Next Header value of 44 in the
#    immediately preceding header, and has the following format:
# 
#    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
#    |  Next Header  |   Reserved    |      Fragment Offset    |Res|M|
#    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
#    |                         Identification                        |
#    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
# 
#    Next Header          8-bit selector.  Identifies the initial header
#                         type of the Fragmentable Part of the original
#                         packet (defined below).  Uses the same values as
#                         the IPv4 Protocol field [RFC-1700 et seq.].
# 
#    Reserved             8-bit reserved field.  Initialized to zero for
#                         transmission; ignored on reception.
# 
#    Fragment Offset      13-bit unsigned integer.  The offset, in 8-octet
#                         units, of the data following this header,
#                         relative to the start of the Fragmentable Part
#                         of the original packet.
# 
#    Res                  2-bit reserved field.  Initialized to zero for
#                         transmission; ignored on reception.
# 
#    M flag               1 = more fragments; 0 = last fragment.
# 
#    Identification       32 bits.  See description below.
# 
#    In order to send a packet that is too large to fit in the MTU of the
#    path to its destination, a source node may divide the packet into
#    fragments and send each fragment as a separate packet, to be
#    reassembled at the receiver.
# 
#    For every packet that is to be fragmented, the source node generates
#    an Identification value. The Identification must be different than
#    that of any other fragmented packet sent recently* with the same
#    Source Address and Destination Address.  If a Routing header is
#    present, the Destination Address of concern is that of the final
#    destination.
# 
#       * "recently" means within the maximum likely lifetime of a packet,
#         including transit time from source to destination and time spent
#         awaiting reassembly with other fragments of the same packet.
#         However, it is not required that a source node know the maximum
#         packet lifetime.  Rather, it is assumed that the requirement can
#         be met by maintaining the Identification value as a simple, 32-
#         bit, "wrap-around" counter, incremented each time a packet must
#         be fragmented.  It is an implementation choice whether to
#         maintain a single counter for the node or multiple counters,
#         e.g., one for each of the node's possible source addresses, or
#         one for each active (source address, destination address)
#         combination.
# 
#    The initial, large, unfragmented packet is referred to as the
#    "original packet", and it is considered to consist of two parts, as
#    illustrated:
# 
#    original packet:
# 
#    +------------------+----------------------//-----------------------+
#    |  Unfragmentable  |                 Fragmentable                  |
#    |       Part       |                     Part                      |
#    +------------------+----------------------//-----------------------+
# 
#       The Unfragmentable Part consists of the IPv6 header plus any
#       extension headers that must be processed by nodes en route to the
#       destination, that is, all headers up to and including the Routing
#       header if present, else the Hop-by-Hop Options header if present,
#       else no extension headers.
# 
#       The Fragmentable Part consists of the rest of the packet, that is,
#       any extension headers that need be processed only by the final
#       destination node(s), plus the upper-layer header and data.
# 
#    The Fragmentable Part of the original packet is divided into
#    fragments, each, except possibly the last ("rightmost") one, being an
#    integer multiple of 8 octets long.  The fragments are transmitted in
#    separate "fragment packets" as illustrated:
# 
#    original packet:
# 
#    +------------------+--------------+--------------+--//--+----------+
#    |  Unfragmentable  |    first     |    second    |      |   last   |
#    |       Part       |   fragment   |   fragment   | .... | fragment |
#    +------------------+--------------+--------------+--//--+----------+
#    fragment packets:
# 
#    +------------------+--------+--------------+
#    |  Unfragmentable  |Fragment|    first     |
#    |       Part       | Header |   fragment   |
#    +------------------+--------+--------------+
# 
#    +------------------+--------+--------------+
#    |  Unfragmentable  |Fragment|    second    |
#    |       Part       | Header |   fragment   |
#    +------------------+--------+--------------+
#                          o
#                          o
#                          o
#    +------------------+--------+----------+
#    |  Unfragmentable  |Fragment|   last   |
#    |       Part       | Header | fragment |
#    +------------------+--------+----------+
# 
#    Each fragment packet is composed of:
# 
#       (1) The Unfragmentable Part of the original packet, with the
#           Payload Length of the original IPv6 header changed to contain
#           the length of this fragment packet only (excluding the length
#           of the IPv6 header itself), and the Next Header field of the
#           last header of the Unfragmentable Part changed to 44.
# 
#       (2) A Fragment header containing:
# 
#                The Next Header value that identifies the first header of
#                the Fragmentable Part of the original packet.
# 
#                A Fragment Offset containing the offset of the fragment,
#                in 8-octet units, relative to the start of the
#                Fragmentable Part of the original packet.  The Fragment
#                Offset of the first ("leftmost") fragment is 0.
# 
#                An M flag value of 0 if the fragment is the last
#                ("rightmost") one, else an M flag value of 1.
# 
#                The Identification value generated for the original
#                packet.
# 
#       (3) The fragment itself.
# 
#    The lengths of the fragments must be chosen such that the resulting
#    fragment packets fit within the MTU of the path to the packets'
#    destination(s).
# 
#    At the destination, fragment packets are reassembled into their
#    original, unfragmented form, as illustrated:
# 
#    reassembled original packet:
# 
#    +------------------+----------------------//------------------------+
#    |  Unfragmentable  |                 Fragmentable                   |
#    |       Part       |                     Part                       |
#    +------------------+----------------------//------------------------+
# 
#    The following rules govern reassembly:
# 
#       An original packet is reassembled only from fragment packets that
#       have the same Source Address, Destination Address, and Fragment
#       Identification.
# 
#       The Unfragmentable Part of the reassembled packet consists of all
#       headers up to, but not including, the Fragment header of the first
#       fragment packet (that is, the packet whose Fragment Offset is
#       zero), with the following two changes:
# 
#          The Next Header field of the last header of the Unfragmentable
#          Part is obtained from the Next Header field of the first
#          fragment's Fragment header.
# 
#          The Payload Length of the reassembled packet is computed from
#          the length of the Unfragmentable Part and the length and offset
#          of the last fragment.  For example, a formula for computing the
#          Payload Length of the reassembled original packet is:
# 
#            PL.orig = PL.first - FL.first - 8 + (8 * FO.last) + FL.last
# 
#            where
#            PL.orig  = Payload Length field of reassembled packet.
#            PL.first = Payload Length field of first fragment packet.
#            FL.first = length of fragment following Fragment header of
#                       first fragment packet.
#            FO.last  = Fragment Offset field of Fragment header of
#                       last fragment packet.
#            FL.last  = length of fragment following Fragment header of
#                       last fragment packet.
# 
#       The Fragmentable Part of the reassembled packet is constructed
#       from the fragments following the Fragment headers in each of the
#       fragment packets.  The length of each fragment is computed by
#       subtracting from the packet's Payload Length the length of the
#       headers between the IPv6 header and fragment itself; its relative
#       position in Fragmentable Part is computed from its Fragment Offset
#       value.
# 
#       The Fragment header is not present in the final, reassembled
#       packet.
# 
#    The following error conditions may arise when reassembling fragmented
#    packets:
# 
#       If insufficient fragments are received to complete reassembly of a
#       packet within 60 seconds of the reception of the first-arriving
#       fragment of that packet, reassembly of that packet must be
#       abandoned and all the fragments that have been received for that
#       packet must be discarded.  If the first fragment (i.e., the one
#       with a Fragment Offset of zero) has been received, an ICMP Time
#       Exceeded -- Fragment Reassembly Time Exceeded message should be
#       sent to the source of that fragment.
# 
#       If the length of a fragment, as derived from the fragment packet's
#       Payload Length field, is not a multiple of 8 octets and the M flag
#       of that fragment is 1, then that fragment must be discarded and an
#       ICMP Parameter Problem, Code 0, message should be sent to the
#       source of the fragment, pointing to the Payload Length field of
#       the fragment packet.
# 
#       If the length and offset of a fragment are such that the Payload
#       Length of the packet reassembled from that fragment would exceed
#       65,535 octets, then that fragment must be discarded and an ICMP
#       Parameter Problem, Code 0, message should be sent to the source of
#       the fragment, pointing to the Fragment Offset field of the
#       fragment packet.
# 
#    The following conditions are not expected to occur, but are not
#    considered errors if they do:
# 
#       The number and content of the headers preceding the Fragment
#       header of different fragments of the same original packet may
#       differ.  Whatever headers are present, preceding the Fragment
#       header in each fragment packet, are processed when the packets
#       arrive, prior to queueing the fragments for reassembly.  Only
#       those headers in the Offset zero fragment packet are retained in
#       the reassembled packet.
# 
#       The Next Header values in the Fragment headers of different
#       fragments of the same original packet may differ.  Only the value
#       from the Offset zero fragment packet is used for reassembly.
# 

=pod

=head1 REFERENCE

=begin html
<BLOCKQUOTE>
<PRE>
RFC 2460 - IPv6 Specification
</PRE>
</BLOCKQUOTE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut