#!/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_6_C-v3_8_2.seq,v 1.1 2006/04/26 05:34:48 akisada Exp $
#
########################################################################

use nd;

BEGIN {}
END   {}

my $ereq = 'ndisc_ereq_LG';
# $cleanup_tn_global = 1;

startNdiscWorld($Link0);

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

if (setupCommon11($Link0) < 0) {
	exitInitFail();
	#NOTREACHED
}

$NOT_USE_FAST_CHANGE_STATE ++;

vLogHTML('<FONT COLOR="#FF0000" SIZE="5"><U><B>TEST PROCEDURE'.
		 '</B></U></FONT><BR>');


if(ndiscNone2DelayLoose($Link0, $ereq) < 0) {
	exitFail();
	#NOTREACHED
}

if(ndRetransTimerProbe($Link0, $ereq) < 0) {
	exitFail();
	#NOTREACHED
}

exitPass();
#NOTREACHED

#------------------------------#
# setupCommon11()              #
#------------------------------#
sub setupCommon11 {
	my ($Link) = @_;

	$NEED_COMMON_CLEANUP = 1;

	if ($V6evalTool::NutDef{'Type'} eq 'router') {
		if(vRemote(
				   'route.rmt',
				   'cmd=add',
				   'prefix=default',
				   "gateway=fe80::200:ff:fe00:a0a0",
				   "if=$V6evalTool::NutDef{'Link0_device'}"
				   )) {
			vLogHTML('<FONT COLOR="#FF0000"><B>'.
					 'route.rmt: Could\'t set route'.
					 '</B></FONT><BR>');
			return($false);
		}

		$tr1_default    = $true;
		return(0);
	}

	my $ra = 'mcast_ra_commonsetup';

	vLogHTML('<FONT COLOR="#FF0000" SIZE="5"><U><B>START COMMON SETUP 1.1'.
		 '</B></U></FONT><BR>');

	# transit REACHABLE
	# send RA
	vClear($Link);
	vSend($Link, $ra);
	vRecv($Link, 3, 0, 0);
	
	my $ereq = 'ereq_commonsetup';
	my @frames = 'ns_setupcommon';
	my $mcast_ns	= '';
	vSend($Link, $ereq);

	my %ret1 = vRecvWrapper($Link, $TimeOut, 0, 0, @frames);
	if($ret1{'recvCount'}) {
		foreach my $frame (@frames) {
			if($ret1{'recvFrame'} eq $frame) {
				$mcast_ns = $frame;
				last;
			}
		}
	}
	
	if($mcast_ns eq '') {
		vLogHTML('<FONT COLOR="#FF0000"><B>'.
				 'Could\'t observe NS</B></FONT><BR>');
		return(-1);
	}

	## send NA
	my $erep = 'erep_commonsetup';
	my $na = 'na_setupcommon';

	vSend($Link, $na);

	my %ret2 = vRecvWrapper($Link, $TimeOut, 0, 0, $erep);
	if($ret2{'recvCount'}) {
		if($ret2{'recvFrame'} ne $erep) {
			return(-1);
		}
	}

	vLogHTML('<FONT COLOR="#FF0000" SIZE="5"><U><B>FINISH COMMON SETUP 1.1'.
		 '</B></U></FONT><BR>');
}

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

=head1 NAME

=begin html
<BLOCKQUOTE><TT>
v6LC_2_1_6_C-v3_8_2 - Neighbor Solicitation Origination, Reachability Confirmation (Neighbor Solicitation Origination, Link-local =&gt; Global)

=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>
                    |
   TN1     NUT      R0
    |       |       |
----+-------+-------+--- Link0
</PRE>
</BLOCKQUOTE>
<P>
<TABLE BORDER>
<TR>
<TD ROWSPAN="2"><TT>Link0</TT></TD>
<TD><TT>global</TT></TD>
<TD><TT>3ffe:501:ffff:100::/64</TT></TD>
</TR>
<TR>
<TD><TT>link-local</TT></TD>
<TD><TT>fe80::/64</TT></TD>
</TR>
<TR>
<TD ROWSPAN="3"><TT>R0</TT></TD>
<TD><TT>global</TT></TD>
<TD><TT>3ffe:501:ffff:100:200:ff:fe00:a0a0</TT></TD>
</TR>
<TR>
<TD><TT>link-local</TT></TD>
<TD><TT>fe80::200:ff:fe00:a0a0</TT></TD>
</TR>
<TR>
<TD><TT>ether</TT></TD>
<TD><TT>00:00:00:00:a0:a0</TT></TD>
</TR>
<TR>
<TD ROWSPAN="3"><TT>TN1</TT></TD>
<TD><TT>global</TT></TD>
<TD><TT>3ffe:501:ffff:100::&lt;TnDef.Link0_addr&gt;</TT></TD>
</TR>
<TR>
<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="3"><TT>NUT</TT></TD>
<TD><TT>global</TT></TD>
<TD><TT>3ffe:501:ffff:100::&lt;NutDef.Link0_addr&gt;</TT></TD>
</TR>
<TR>
<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>
<TT><B>This minimal setup procedure provides the NUT with a default router TR1, a global prefix, and ensures that the NUT can communicate with TR1.</B></TT>
<BLOCKQUOTE>
<PRE>
   TR1     HUT
    |       |
    | -->   | RA
    |       |
    *       | Wait (MAX_RTR_SOLICITATION_DELAY + RetransTimer * DupAddrDetectTransmits)
    |       |
    | ----> | Echo Request
    |   <-- | NS
    | ----> | NA
    | <---- | Echo Reply
    |       |
    V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
1. Send RA
</PRE>
<PRE>
        IPv6 header
            hop limit          = 255
            source             = TR1 (link-local)
            destination        = all-nodes multicast address
        RA
            cur hop limit      = 64
            M                  = 0
            O                  = 0
            router lifetime    = 1800
            reachable time     = 30000
            retrans timer      = 1000
        Prefix Information option
            prefix length      = 64
            L                  = 1
            A                  = 1
            valid Lifetime     = 2592000
            preferred lifetime = 604800
            prefix             = 3ffe:501:ffff:100::
</PRE>
<PRE>
2.  Wait (MAX_RTR_SOLICITATION_DELAY + RetransTimer * DupAddrDetectTransmits)
</PRE>
<PRE>
        Host constants:
            MAX_RTR_SOLICITATION_DELAY: 1 second
</PRE>
<PRE>
        Node constants:
            RETRANS_TIMER             : 1,000 milliseconds
</PRE>
<PRE>
        Host Variables:
            RetransTimer
                Default               : RETRANS_TIMER milliseconds
</PRE>
<PRE>
        Node Variables:
            DupAddrDetectTransmits
                Default               : 1
</PRE>
<PRE>
3. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source      = TR1 (link-local)
            destination = HUT (link-local)
        Echo Request
</PRE>
<PRE>
4. Observe NS
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = HUT (link-local)
            destination = TR1 (solicited-node multicast address)
        NS
            target      = TR1 (link-local)
        SLL option
</PRE>
<PRE>
5. Send NA
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = TR1 (link-local)
            destination = HUT (link-local)
        NA
            R           = 1
            S           = 1
            O           = 1
            target      = TR1 (link-local)
        TLL option
</PRE>
<PRE>
6. Observe Echo Reply
</PRE>
<PRE>
        IPv6 header
            source      = HUT (link-local)
            destination = TR1 (link-local)
        Echo Reply
</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 PROBE state</B></TT><BR>
<TT><B>- Verify that NUT transmits multicast NSs 3 times</B></TT><BR>
<BLOCKQUOTE>
<PRE>
   TN1     NUT
    |       |
    | ----> | Echo Request
    |   <-- | NS (multicast)
    | ----> | NA
    | <---- | Echo Reply
    |       |
    *       | Wait (REACHABLE_TIME * MAX_RANDOM_FACTOR)
    |       |
    | ----> | Echo Request
    | <---- | Echo Reply
    |       |
    *       | Wait (DELAY_FIRST_PROBE_TIME)
    |       |
    | <---- | NS (unicast) [<A HREF="#PRC1">Judgment #1</A>]
    | <---- | NS (unicast)
    | <---- | NS (unicast)
    |       |
    V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
1. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source      = TN1 (link-local)
            destination = NUT (global)
        Echo Request
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">INCOMPLETE</FONT> (TN1) (link-local)
</PRE>
<PRE>
2. Observe NS
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = NUT (global)
            destination = TN1 (solicited-node multicast address)
        NS
            target      = TN1 (link-local)
        SLL option
</PRE>
<PRE>
3. Send NA
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = TN1 (link-local)
            destination = NUT (global)
        NA
            R           = 0
            S           = 1
            O           = 1
            target      = TN1 (link-local)
        TLL option
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">REACHABLE</FONT> (TN1) (link-local)
</PRE>
<PRE>
4. Observe Echo Reply
</PRE>
<PRE>
        IPv6 header
            source      = NUT (global)
            destination = TN1 (link-local)
        Echo Reply
</PRE>
<PRE>
5. Wait (REACHABLE_TIME * MAX_RANDOM_FACTOR)
</PRE>
<PRE>
        Node constants:
            REACHABLE_TIME   : 30,000 milliseconds
            MAX_RANDOM_FACTOR: 1.5
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">STALE</FONT> (TN1) (link-local)
</PRE>
<PRE>
6. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source      = TN1 (link-local)
            destination = NUT (global)
        Echo Request
</PRE>
<PRE>
7. Observe Echo Reply
</PRE>
<PRE>
        IPv6 header
            source      = NUT (global)
            destination = TN1 (link-local)
        Echo Reply
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">DELAY</FONT> (TN1) (link-local)
</PRE>
<PRE>
8. Wait (DELAY_FIRST_PROBE_TIME)
</PRE>
<PRE>
        Node constants:
            DELAY_FIRST_PROBE_TIME: 5 seconds
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">PROBE</FONT> (TN1) (link-local)
</PRE>
<PRE>
<A NAME="PRC1">9. Observe MAX_UNICAST_SOLICIT NSs [<A HREF="#JDG1">Judgment #1</A>]
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = NUT (link-local)
            destination = TN1 (link-local)
        NS
            target      = TN1 (link-local)
        SLL option
</PRE>
<PRE>
        Node constants:
            MAX_UNICAST_SOLICIT: 3 transmissions
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN1) (link-local)
</PRE>
</BLOCKQUOTE>

=end html

=head1 JUDGEMENT

=begin html
<BLOCKQUOTE>
<PRE>
<A NAME="JDG1">[<A HREF="#PRC1">Judgment #1</A>] NUT must transmit 3 NSs to TN1
</PRE>
</BLOCKQUOTE>

=end html

=head1 CLEANUP

=begin html
<BLOCKQUOTE>
<TT><B>- Remove global address</B></TT><BR>
<BLOCKQUOTE>
<PRE>
   TN1     NUT      R0
    |       |       |
    |       |   <-- | RA (rltime=0, vltime=0, pltime=0) (If NUT isn't Router)
    |       |       |
    V       V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN1) (link-local)
</PRE>
<PRE>
1. Send RA (If NUT isn't Router)
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = R0 (link-local)
            destination = all-nodes multicast address
        RA
            cur hop limit   = 64
            M               = 0
            O               = 0
            router lifetime = 0
            reachable time  = 0
            retrans timer   = 0
        Prefix Information option
            prefix length      = 64
            L                  = 1
            A                  = 1
            valid Lifetime     = 0
            preferred lifetime = 0
            prefix             = 3ffe:501:ffff:100::
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN1) (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>
#    If the source address of the packet prompting the solicitation is the
#    same as one of the addresses assigned to the outgoing interface, that
#    address <FONT COLOR="#FF0000">SHOULD</FONT> be placed in the IP Source Address of the outgoing
#    solicitation.  <U><B>Otherwise, any one of the addresses assigned to the</B></U>
#    <U><B>interface should be used.</B></U>  Using the prompting packet's source
#    address when possible insures that the recipient of the Neighbor
#    Solicitation installs in its Neighbor Cache the IP address that is
#    highly likely to be used in subsequent return traffic belonging to
#    the prompting packet's "connection".
# </PRE>
# <PRE>
#    If the solicitation is being sent to a solicited-node multicast
#    address, the sender <FONT COLOR="#FF0000">MUST</FONT> include its link-layer address (if it has
#    one) as a Source Link-Layer Address option.  <U><B>Otherwise, the sender</B></U>
#    <U><B><FONT COLOR="#FF0000">SHOULD</FONT> include its link-layer address (if it has one) as a Source</B></U>
#    <U><B>Link-Layer Address option.</B></U>  Including the source link-layer address
#    in a multicast solicitation is required to give the target an address
#    to which it can send the Neighbor Advertisement.  On unicast
#    solicitations, an implementation <FONT COLOR="#FF0000">MAY</FONT> omit the Source Link-Layer
#    Address option. The assumption here is that if the sender has a
#    peer's link-layer address in its cache, there is a high probability
#    that the peer will also have an entry in its cache for the sender.
#    Consequently, it need not be sent.
# </PRE>
# <P>
# <FONT SIZE="+1"><TT>RFC2461 Neighbor Discovery for IPv6</TT></FONT>
# <HR>
# <PRE>
# 7.3.3.  Node Behavior
# </PRE>
# <PRE>
#    Upon entering the PROBE state, a node sends a unicast Neighbor
#    Solicitation message to the neighbor using the cached link-layer
#    address.  While in the PROBE state, a node retransmits Neighbor
#    Solicitation messages every RetransTimer milliseconds until
#    reachability confirmation is obtained.  Probes are retransmitted even
#    if no additional packets are sent to the neighbor.  <U><B>If no response is</B></U>
#    <U><B>received after waiting RetransTimer milliseconds after sending the</B></U>
#    <U><B>MAX_UNICAST_SOLICIT solicitations, retransmissions cease and the</B></U>
#    <U><B>entry <FONT COLOR="#FF0000">SHOULD</FONT> be deleted.</B></U>  Subsequent traffic to that neighbor will
#    recreate the entry and performs address resolution again.
# </PRE>
# </BLOCKQUOTE>
# 
# =end html
# 

=pod

=head1 REFERENCE

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

=end html

=cut