#!/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_1_C.seq,v 1.4 2005/06/14 05:54:40 akisada Exp $
#
########################################################################

use nd;

BEGIN {}
END   {}

if($V6evalTool::NutDef{'Type'} eq 'router') {
	vLogHTML('<FONT COLOR="#FF0000" SIZE="5"><U><B>TEST SETUP FOR ROUTER'.
			 '</B></U></FONT><BR>');
	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>');
		exitFatal();
		#NOTREACHED
	}
	$NEED_COMMON_CLEANUP = 1;
}

startNdiscWorld($Link0);

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

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

$SeekTime = 0;

my @frames = ('ndisc_mcast_ns_sll_GG');

if($IGN_NS_SRC_ADDR) {
	push(@frames, 'ndisc_mcast_ns_sll_LG');
}

vSend($Link0, 'ndisc_ereq_GG');

my %ret = vRecvWrapper($Link0, $TimeOut, $SeekTime, 0, @frames);

if($ret{'recvCount'}) {
	foreach my $frame (@frames) {
		if($ret{'recvFrame'} eq $frame) {
			flushBuffer($Link0, $TimeOut, $TimeOut);
			exitPass();
		}
	}
}

vLogHTML('<FONT COLOR="#FF0000"><B>Could\'t observe NS</B></FONT><BR>');

exitFail();
#NOTREACHED



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

=head1 NAME

=begin html
<BLOCKQUOTE><TT>
V6LC_2_1_1_C - On-Link Determination (Global Address, On-link Prefix covers TN1)

=end html

=begin html
</TT></BLOCKQUOTE>

=end html

=head1 TARGET

=begin html
<BLOCKQUOTE>
<TT>Host</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="3"><TT>TN</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>
<PRE>
If the NUT is a router, configure a default route with TR1 as next hop.
</PRE>
</BLOCKQUOTE>

=end html

=head1 TEST PROCEDURE

=begin html
<BLOCKQUOTE>
<TT><B>- Verify that NUT assumes the destination is off-link</B></TT><BR>
<BLOCKQUOTE>
<PRE>
    TN     NUT
    |       |
    | -->   | RA
    |       |
    *       | Wait (MAX_RTR_SOLICITATION_DELAY + RetransTimer * DupAddrDetectTransmits)
    |       |
    | ----> | Echo Request
    |   <-- | NS (multicast) [<A HREF="#PRC1">Judgment #1</A>]
    |   <-- | NS (multicast)
    |   <-- | NS (multicast)
    |       |
    V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN) (global)
</PRE>
<PRE>
1. Send RA
</PRE>
<PRE>
        IPv6 header
            hop limit          = 255
            source             = TN (link-local)
            destination        = all-nodes multicast address
        RA
            cur hop limit      = 64
            M                  = 0
            O                  = 0
            router lifetime    = 1800
            reachable time     = 0
            retrans timer      = 0
        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>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN) (global)
</PRE>
<PRE>
3. Send Echo Request
</PRE>
<PRE>
        IPv6 header
            source      = TN  (global)
            destination = NUT (global)
        Echo Request
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">INCOMPLETE</FONT> (TN) (global)
</PRE>
<PRE>
<A NAME="PRC1">4. Observe MAX_MULTICAST_SOLICIT NSs [<A HREF="#JDG1">Judgment #1</A>]
</PRE>
<PRE>
        IPv6 header
            hop limit   = 255
            source      = NUT (global)
            destination = TN  (solicited-node multicast address)
        NS
            target      = TN  (global
        SLL option
</PRE>
<PRE>
        Node constants:
            MAX_MULTICAST_SOLICIT: 3 transmissions
</PRE>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN) (global)
</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 TN (solicited-node multicast address)
</PRE>
</BLOCKQUOTE>

=end html

=head1 CLEANUP

=begin html
<BLOCKQUOTE>
<TT><B>- Remove global address</B></TT><BR>
<TT><B>- Clear default router</B></TT><BR>
<BLOCKQUOTE>
<PRE>
    TN     NUT
    |       |
    | ----> | RA (rltime=0, vltime=0, pltime=0)
    |       |
    V       V
</PRE>
</BLOCKQUOTE>
<P>
<PRE>
    State: <FONT COLOR="#FF0000">NONE</FONT> (TN) (global)
</PRE>
<PRE>
1. Send RA
</PRE>
<PRE>
        IPv6 header
            hop limit          = 255
            source             = TN (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> (TN) (global)
</PRE>
</BLOCKQUOTE>

=end html

=cut

# =head1 REFERENCE
# 
# =begin html
# <BLOCKQUOTE>
# <FONT SIZE="+1"><TT>RFC2461 Neighbor Discovery for IPv6</TT></FONT>
# <HR>
# <PRE>
# 5.2.  Conceptual Sending Algorithm
# </PRE>
# <PRE>
#    Next-hop determination for a given unicast destination operates as
#    follows.  The sender performs a longest prefix match against the
#    Prefix List to determine whether the packet's destination is on- or
#    off-link.  <U><B>If the destination is on-link, the next-hop address is the</B></U>
#    <U><B>same as the packet's destination address.</B></U>  Otherwise, the sender
#    selects a router from the Default Router List (following the rules
#    described in Section 6.3.6).  If the Default Router List is empty,
#    the sender assumes that the destination is on-link.
# </PRE>
# </BLOCKQUOTE>
# 
# =end html
# 

=pod

=head1 REFERENCE

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

=end html

=cut