#!/usr/bin/perl
#
# Copyright (C) 1999,2000 Yokogawa Electric Corporation and
#                         YDC 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: hostRecvRaRLifetimeN.seq,v 1.1.1.1 2000/10/31 22:39:33 sekiya Exp $

########################################################################
BEGIN { $V6evalTool::TestVersion = '$Name:  $ '; }
 
use V6evalTool;
use nd;

sub checkDefaultRouter($);

ndOptions(@ARGV);

# The following generate debugging messages.
$nd::debug=$ndOpt_v|$ndOpt_vv;

# You can specifies debug optons to a remote control program.
# If you want to know more detail, please see the following:
# - V6evalTool.pm: perldoc V6evalTool
# - V6evalRemote.pm: perldoc V6evalRemote
$nd::remote_debug="-o1" if $ndOpt_vv;

$IF=Link0;

$wait_dad=3;
$wait_echo=2;
$wait_clear=5+2;
$wait_probe=$nd::DELAY_FIRST_PROBE_TIME +
    ($nd::RETRANS_TIMER * $nd::MAX_UNICAST_SOLICIT) + 1;

#
#
#
$type=$V6evalTool::NutDef{Type};
if($type eq router) {
    vLogHTML("This test is for the host only<BR>");
    exit $V6evalTool::exitHostOnly;
}

$type=$V6evalTool::NutDef{Type};
if($type ne host) {
    vLogHTML(ndErrmsg("ERROR: $V6evalTool::NutDef{Type}: ".
		      "Unknown target type<BR>"));
    exit $V6evalTool::exitFail;
}

#
#
#
vLogHTML("<HR><FONT SIZE=\"+1\">Initialization</FONT><BR>");
vCapture($IF);

#
#
#
#goto error if ndClearPrefix() != 0;
#goto error if ndClearDefr() != 0;
#goto error if nd2NoNce($IF) != 0;

#
# 
#
$pktdesc{ra_tn2allnode_sll}='Router TN Send RA w/ SLL, NC[TN]=STALE';
$pktdesc{ra_y2allnode_sll}='Router Y Send RA w/ SLL, NC[Y]=STALE';
$pktdesc{ra_z2allnode_sll}='Router Z Send RA w/ SLL, NC[Y]=STALE';
%ret=vSend($IF,
	   ra_tn2allnode_sll,
	   ra_y2allnode_sll,
	   ra_z2allnode_sll,
	   );
goto error if $ret{status} != 0;

vLogHTML("Wait for DAD NSs<BR>");
vRecv($IF, $wait_dad, 0, 0);

$pktdesc{unicast_na_tn2nut_RSO_tll}='Rouer TN send NA, NC[TN]=REACHABLE';
$pktdesc{unicast_na_y2nut_RSO_tll}='Rouer Y send NA, NC[Y]=REACHABLE';
$pktdesc{unicast_na_z2nut_RSO_tll}='Rouer Z send NA, NC[Z]=REACHABLE';
%ret=vSend($IF,
	   unicast_na_tn2nut_RSO_tll,
	   unicast_na_y2nut_RSO_tll,
	   unicast_na_z2nut_RSO_tll,
	   );

$i=0;
$tn_done=0;
$y_done=0;
$z_done=0;
vLogHTML("<HR><FONT SIZE=\"+1\">Test</FONT><BR>");
while(1) {
    $s=checkDefaultRouter($p);
    if($s eq echo_reply_nut2x_via_tn) {
	if($tn_done) {
	    vLogHTML(ndErrmsg("ERROR: NUT doesn't recognize RA ".
			      "(RouterLifetime=5)<BR>"));
	    goto error;
	}
        $pktdesc{ra_tn2allnode_sll_clear}=
            'Router TN send RA w/ RouterLifetime=5';
	$p='ra_tn2allnode_sll_clear';
	$tn_done=1;
    } elsif($s eq echo_reply_nut2x_via_y) {
	if($y_done) {
	    vLogHTML(ndErrmsg("ERROR: NUT doesn't recognize RA ".
			      "(RouterLifetime=5)<BR>"));
	    goto error;
	}
        $pktdesc{ra_y2allnode_sll_clear}=
            'Router Y send RA w/ RouterLifetime=5';
	$p='ra_y2allnode_sll_clear';
	$y_done=1;
    } elsif($s eq echo_reply_nut2x_via_z) {
	if($z_done) {
	    vLogHTML(ndErrmsg("ERROR: NUT doesn't recognize RA ".
			      "(RouterLifetime=5)<BR>"));
	    goto error;
	}
        $pktdesc{ra_z2allnode_sll_clear}=
            'Router Z send RA w/ RouterLifetime=5';
	$p='ra_z2allnode_sll_clear';
	$z_done=1;
    } else {
	last;
    }
    $i++;
}

#
#
#
clear();

#
#
#
if($i < 2) {
    vLogHTML("*** NG ***<BR>");
    exit $V6evalTool::exitFail;
} elsif($i == 2) {
    vLogHTML("*** OK ***<BR>");
    exit $V6evalTool::exitPass;
} else {
    vLogHTML("Well done!! NUT retains more than two router addresses " .
	     "in the Default Router List<BR>");
    vLogHTML("*** OK ***<BR>");
    exit $V6evalTool::exitPass;
}

error:
    clear();
    vLogHTML(vErrmsg(%ret)."<BR>");
    vLogHTML(ndErrmsg("*** NG ***<BR>"));
    exit $V6evalTool::exitFail;

sub checkDefaultRouter($)
{
    my($ra)=@_;

    if(! ($ra =~ /^\s*$/)) {
	vSend($IF, $ra);
	vLogHTML("Wait for expiring RouterLifetime ($wait_clear sec)<BR>");
	vSleep($wait_clear);
    }

    $pktdesc{echo_request_x2nut_via_w}='Send off-link echo-requests';
    %ret=vSend($IF, echo_request_x2nut_via_w);

    $pktdesc{echo_reply_nut2x_via_tn}=
        'Got echo-reply thrown to Router TN';
    $pktdesc{echo_reply_nut2x_via_y}=
        'Got echo-reply thrown to Router Y';
    $pktdesc{echo_reply_nut2x_via_z}=
        'Got echo-reply thrown to Router Z';
    $pktdesc{multicast_ns_nut2wsolnode}=
        'Got multicast NS for neighbor discovery';
    %ret=vRecv($IF, $wait_echo, $ret{sentTime1}, 1,
	       echo_reply_nut2x_via_tn,
	       echo_reply_nut2x_via_y,
	       echo_reply_nut2x_via_z,
	       multicast_ns_nut2wsolnode,
	       );
    if($ret{status} == 0) {
	vLogHTML("Wait ($wait_probe sec)to ignore unicast NSs if any<BR>");
	vRecv($IF, $wait_probe, 0, 0);
	return($ret{recvFrame});
    } elsif($ret{status} == 1) {
	vLogHTML("Got nothing<BR>");
	return('');
    }

error:
    clear();
    vLogHTML(vErrmsg(%ret)."<BR>");
    vLogHTML(ndErrmsg("*** NG ***<BR>"));
    exit $V6evalTool::exitFail;
}

sub clear()
{
    vLogHTML("<HR><FONT SIZE=\"+1\">Termination</FONT><BR>");
    $pktdesc{ra_tn2allnode_clrrtr}=
        'Clear Router TN form the Default Router List';
    $pktdesc{ra_y2allnode_clrrtr}=
        'Clear Router Y form the Default Router List';
    $pktdesc{ra_z2allnode_clrrtr}=
        'Clear Router Z form the Default Router List';
    vSend($IF, 
	  ra_tn2allnode_clrrtr,
	  ra_y2allnode_clrrtr,
	  ra_z2allnode_clrrtr,
	  );
}

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

=head1 NAME

hostRecvRaRLifetimeN - Verifying that a host recognize RouterLifetime!=0

=head1 TARGET

Host only

=head1 SYNOPSIS

  hostRecvRaRLifetimeN.seq [-tooloption ...] -p hostRecvRaRLifetimeN.def

=head1 INITIALIZATION

=begin html
<OL>
  <LI>Create neighbor cache entries for NUT, Y, Z.
  <LI>Set their state to REACHABLEs.
  <LI>Give a global prefix, 3ffe:501:ffff:100::/64
</OL>
<PRE>
  TN                 NUT
  ----------------------
<BR>
  State: NONCE (for all)
<BR>
  ==== unsolicited RA ===>
       src=TN's link-local
       dst=all-node
       M=0, O=0
       RouterLifetime=600
       ReachableTime=0
       RetransTimer=0
       w/ SLLA
       Prefix Option:
           L=1, A=1
           ValidLifetime=2592000
           PreferredLifetime=604800
           Prefix=3ffe:501:ffff:100::/64
<BR>
  State: STALE (for TN), NONCE (for Y, Z)
<BR>
  ==== unsolicited RA ===>
       src=Y's link-local
       dst=all-node
       M=0, O=0
       RouterLifetime=600
       ReachableTime=0
       RetransTimer=0
       w/ SLLA
       Prefix Option:
           L=1, A=1
           ValidLifetime=2592000
           PreferredLifetime=604800
           Prefix=3ffe:501:ffff:100::/64
<BR>
  State: STALE (for TN, Y), NONCE (for Z)
<BR>
  ==== unsolicited RA ===>
       src=Z's link-local
       dst=all-node
       M=0, O=0
       RouterLifetime=600
       ReachableTime=0
       RetransTimer=0
       w/ SLLA
       Prefix Option:
           L=1, A=1
           ValidLifetime=2592000
           PreferredLifetime=604800
           Prefix=3ffe:501:ffff:100::/64
<BR>
  State: STALE (for all)
<BR>
  <=== Ns for DAD ====
       src=unspecified
       dst=solicited-node[NUT's global, prefix=3ffe:501:ffff:100::/64]
       target=NUT's global
<BR>
  Wait (3 sec)
<BR>
  ==== solicited NA ===>
        src=TN's link-local
        dst=NUT's link-local
        R=1, S=1, O=1
        target=TN's link-local
        TLLA=TN's LLA
<BR>
  State: REACHABLE (for TN), STALE (for Y and Z)
  ==== solicited NA ===>
        src=Y's link-local
        dst=NUT's link-local
        R=1, S=1, O=1
        target=Y's link-local
        TLLA=X's LLA
<BR>
  State: REACHABLE (for TN, Y), STALE (for Z)
  ==== solicited NA ===>
        src=Z's link-local
        dst=NUT's link-local
        R=1, S=1, O=1
        target=Z's link-local
        TLLA=Z's LLA
<BR>
  State: REACHABLE (for all)
</PRE>

=end html

=head1 TEST PROCEDURE

=begin html
<BR>
<B>hostRecvRaRLifetimeN</B> verifies that
<UL>
  <LI>a host recognizes RouterLifetime.
  <LI>a host updates the Default Router List if its entry is expires.
  <LI>the Default Router List holds at the least two entries.
</UL>
<PRE>
  TN               NUT
  ----------------------
<BR>
  State: REACHABLE (for all)
<BR>
  ==== echo-request ===>
       src=off-link global, but LLA is the W's one
       dst=NUT's global
<BR>
  <=== <A HREF="#JDG4">Judgment #4</A>: echo-reply ====
       src=NUT's global
       dst=off-link global, but LLA is one of the routers(TN, Y, Z)
<BR>
  ==== unsolicited RA ===>
       src=TN's link-local
       dst=all-node
       M=0, O=0
       <B>RouterLifetime=5</B>
       ReachableTime=0
       RetransTimer=0
       w/ SLLA
<BR>
  Wait (7 sec)
      for the entry of the Default Router List to be expired.
<BR>
  ==== echo-request ===>
       src=off-link global, but LLA is the W's one
       dst=NUT's global
<BR>
  <=== <A HREF="#JDG5">Judgment #5</A>: echo-reply ====
       src=NUT's global
       dst=off-link global, but LLA is one of the routers(Y, Z)
<BR>
  ==== unsolicited RA ===>
       src=Y's link-local
       dst=all-node
       M=0, O=0
       <B>RouterLifetime=5</B>
       ReachableTime=0
       RetransTimer=0
       w/ SLLA
<BR>
  Wait (7 sec)
      for the entry of the Default Router List to be expired.
<BR>
  ==== echo-request ===>
       src=off-link global, but LLA is the W's one
       dst=NUT's global
<BR>
  <=== <A HREF="#JDG6">Judgment #6</A>: echo-reply ====
       src=NUT's global
       dst=off-link global, but LLA is one of the routers(Z)
<BR>
  ==== unsolicited RA ===>
       src=Z's link-local
       dst=all-node
       M=0, O=0
       <B>RouterLifetime=5</B>
       ReachableTime=0
       RetransTimer=0
       w/ SLLA
<BR>
  Wait (7 sec)
      for the entry of the Default Router List to be expired.
<BR>
  ==== echo-request ===>
       src=off-link global, but LLA is the W's one
       dst=NUT's global
<BR>
  <=== <A HREF="#JDG7">Judgment #7</A>: multicast NS (if any) ====
       src=NUT's global
       dst=solicite-noded[off-link global]
       w/ SLLA
</PRE>

=end html

=head1 JUDGMENT

=for html <A NAME="JDG1"></A>

  1. If the address is already present in the host's Default Router
     List and the received Router Lifetime value is zero, immediately
     time-out the entry.

=for html <A NAME="JDG2"></A>

  2. Whenever the Lifetime of an entry in the Default Router List expires,
     that entry is discarded.  When removing a router from the Default
     Router list, NUT must update the Destination Cache in such a way
     that all entries using the router perform next-hop determination
     again rather than continue sending traffic to the (deleted) router.

=for html <A NAME="JDG3"></A>

  3. NUT must retain at least two router addresses and should retain more. 

=for html <A NAME="JDG4"></A>

  4. NUT must throw an echo-reply to the default router (NUT or Y or Z).

=for html <A NAME="JDG5"></A>

  5. NUT must throw an echo-reply to the default router (Y or Z).

=for html <A NAME="JDG6"></A>

  6. NUT must throw an echo-reply to the default router (i.e. Z).

=for html <A NAME="JDG7"></A>

  7. NUT must not throw an echo-reply to any routers.
     NUT may throw multicast NS for onlink determination.

=head1 TERMINATION

  Send RAs to clear the Default Router List:
  - RA (src=TN) with RouterLifetime=0
  - RA (src=Y)  with RouterLifetime=0
  - RA (src=Z)  with RouterLifetime=0

=head1 NOTE

  The test does not invoke any remote command.

=head1 SEE ALSO

  perldoc V6evalTool
  perldoc V6evalRemote

=cut