#!/usr/bin/perl
#
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
# 	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.
#
# $TAHI: ct/nd.p2/V6LC_2_1_2_A.seq,v 1.5 2005/06/14 06:03:15 akisada Exp $
#
########################################################################

use nd;

BEGIN {}
END   {}

my $max		= $WAIT_QUEUE_LMT;
my %echo	= ();

if(ndResolutionWaitQueueSingleSetup($max, \%echo) < 0) {
	exitFatal();
	#NOTREACHED
}

startNdiscWorld($Link0);

if(setupCase2($Link0) < 0) {
	exitFatal();
	#NOTREACHED
}

if(ndResolutionWaitQueueSingle($Link0, \%echo) < 0) {
	exitFail();
	#NOTREACHED
}

exitPass();
#NOTREACHED


#
# perldoc
#
########################################################################
__END__

=head1 NAME

=begin html
<BLOCKQUOTE><TT>
V6LC_2_1_2_A - Resolution Wait Queue (Single Queue)

=end html

=begin html
</TT></BLOCKQUOTE>

=end html

=head1 TARGET

=begin html
<BLOCKQUOTE>
<TT>Host/Router</TT>
</BLOCKQUOTE>

=end html

=head1 TOPOLOGY

=begin html
<BLOCKQUOTE>
<BLOCKQUOTE>
<PRE>
    TN     NUT
    |       |
----+-------+--- Link0
</PRE>
</BLOCKQUOTE>
<P>
<TABLE BORDER>
<TR>
<TD><TT>Link0</TT></TD>
<TD><TT>link-local</TT></TD>
<TD><TT>fe80::/64</TT></TD>
</TR>
<TR>
<TD ROWSPAN="2"><TT>TN</TT></TD>
<TD><TT>link-local</TT></TD>
<TD><TT>fe80::&lt;TnDef.Link0_addr&gt;</TT></TD>
</TR>
<TR>
<TD><TT>ether</TT></TD>
<TD><TT>&lt;TnDef.Link0_addr&gt;</TT></TD>
</TR>
<TR>
<TD ROWSPAN="2"><TT>NUT</TT></TD>
<TD><TT>link-local</TT></TD>
<TD><TT>fe80::&lt;NutDef.Link0_addr&gt;</TT></TD>
</TR>
<TR>
<TD><TT>ether</TT></TD>
<TD><TT>&lt;NutDef.Link0_addr&gt;</TT></TD>
</TR>
</TABLE>
</BLOCKQUOTE>

=end html

=head1 SETUP

=begin html
<BLOCKQUOTE>
<PRE>
none
</PRE>
</BLOCKQUOTE>

=end html

=head1 INITIALIZATION

=begin html
<BLOCKQUOTE>
<PRE>
none
</PRE>
</BLOCKQUOTE>

=end html

=head1 TEST PROCEDURE

=begin html
<BLOCKQUOTE>
<TT><B>- Verify that NUT transmits valid NSs in INCOMPLETE state</B></TT><BR>
<TT><B>- Verify that NUT can transmit Echo Reply after address resolution</B></TT><BR>
<TT><B>- Verify that NUT replaces the oldest entry and the new arrival packet, when a queue overflows.</B></TT>
<BLOCKQUOTE>
<PRE>
    TN     NUT
    |       |
    | ----> | Echo Request (SN=0)
    | ----> | Echo Request (SN=1)
    | ----> | Echo Request (SN=2)
    |       |
    |   <-- | NS (multicast)      [<A HREF="#PRC1">Judgment #1</A>]
    | ----> | NA
    |       |
    | <---- | Echo Reply   (SN=2) [<A HREF="#PRC2">Judgment #2</A>]
    |       |
    V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN) (link-local)
</PRE>
<PRE>
1. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source          = TN  (link-local)
            destination     = NUT (link-local)
        Echo Request
            sequence number = 0
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">INCOMPLETE</FONT> (TN) (link-local)
</PRE>
<PRE>
2. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source          = TN  (link-local)
            destination     = NUT (link-local)
        Echo Request
            sequence number = 1
</PRE>
<PRE>
3. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source          = TN  (link-local)
            destination     = NUT (link-local)
        Echo Request
            sequence number = 2
</PRE>
<PRE>
<A NAME="PRC1">4. Observe NS [<A HREF="#JDG1">Judgment #1</A>]
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = NUT (link-local)
            destination = TN  (solicited-node multicast address)
        NS
            target      = TN  (link-local)
        SLL option
</PRE>
<PRE>
5. Send NA
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = TN  (link-local)
            destination = NUT (link-local)
        NA
            R           = 0
            S           = 1
            O           = 1
            target      = TN  (link-local)
        TLL option
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">REACHABLE</FONT> (TN) (link-local)
</PRE>
<PRE>
<A NAME="PRC2">6. Observe Echo Reply [<A HREF="#JDG2">Judgment #2</A>]
</PRE>
<PRE>
        IPv6 header
            source          = NUT (link-local)
            destination     = TN  (link-local)
        Echo Reply
            sequence number = 2
</PRE>
</BLOCKQUOTE>

=end html

=head1 JUDGEMENT

=begin html
<BLOCKQUOTE>
<PRE>
<A NAME="JDG1">[<A HREF="#PRC1">Judgment #1</A>] NUT must transmit NSs to TN
<A NAME="JDG2">[<A HREF="#PRC2">Judgment #2</A>] NUT must transmit Echo Reply to TN
</PRE>
</BLOCKQUOTE>

=end html

=head1 CLEANUP

=begin html
<BLOCKQUOTE>
<TT><B>- Set neighbor cache state for TN to NONE</B></TT><BR>
<BLOCKQUOTE>
<PRE>
    TN     NUT
    |       |
    | ----> | NS (unicast) (different cached address)
    | <---- | NA
    |       |
    *       | Wait (DELAY_FIRST_PROBE_TIME)
    |       |
    | <---- | NS (unicast)
    | <---- | NS (unicast)
    | <---- | NS (unicast)
    |       |
    V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
    State: <FONT COLOR="#FF0000">REACHABLE</FONT> (TN) (link-local)
</PRE>
<PRE>
1. Send NS
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = TN  (link-local)
            destination = NUT (link-local)
        NS
            target      = NUT (link-local)
        SLL option
            address     = H0  (ether)
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">STALE</FONT> (TN) (link-local)
</PRE>
<PRE>
2. Observe NA
</PRE>
<PRE>
        IPv6 header
            source      = NUT (link-local)
            destination = TN  (link-local)
        NA
            R           = 0   (If NUT is Host)
                        = 1   (If NUT is Router)
            S           = 1
            O           = 1
            target      = NUT (link-local)
        TLL option
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">DELAY</FONT> (TN) (link-local)
</PRE>
<PRE>
3. Wait (DELAY_FIRST_PROBE_TIME)
</PRE>
<PRE>
        Node constants:
            DELAY_FIRST_PROBE_TIME: 5 seconds
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">PROBE</FONT> (TN) (link-local)
</PRE>
<PRE>
4. Observe MAX_UNICAST_SOLICIT NSs
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = NUT (link-local)
            destination = TN  (link-local)
        NS
            target      = TN  (link-local)
        SLL option
</PRE>
<PRE>
        Node constants:
            MAX_UNICAST_SOLICIT: 3 transmissions
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN) (link-local)
</PRE>
</BLOCKQUOTE>

=end html

=cut

# =head1 REFERENCE
# 
# =begin html
# <BLOCKQUOTE>
# <FONT SIZE="+1"><TT>RFC2461 Neighbor Discovery for IPv6</TT></FONT>
# <HR>
# <PRE>
# 7.2.2.  Sending Neighbor Solicitations
# </PRE>
# <PRE>
#    While waiting for address resolution to complete, the sender <FONT COLOR="#FF0000">MUST</FONT>,
#    for each neighbor, retain a small queue of packets waiting for
#    address resolution to complete.  <U><B>The queue <FONT COLOR="#FF0000">MUST</FONT> hold at least one</B></U>
#    <U><B>packet, and <FONT COLOR="#FF0000">MAY</FONT> contain more.</B></U>  However, the number of queued packets
#    per neighbor <FONT COLOR="#FF0000">SHOULD</FONT> be limited to some small value.  <U><B>When a queue</B></U>
#    <U><B>overflows, the new arrival <FONT COLOR="#FF0000">SHOULD</FONT> replace the oldest entry.</B></U>  <U><B>Once</B></U>
#    <U><B>address resolution completes, the node transmits any queued packets.</B></U>
# </PRE>
# </BLOCKQUOTE>
# 
# =end html
# 

=pod

=head1 REFERENCE

=begin html
<BLOCKQUOTE>
<PRE>
RFC 2461 - Neighbor Discovery for IPv6
</PRE>
</BLOCKQUOTE>

=end html

=cut