#!/usr/bin/perl
#
#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: C_RFC3736_INfoRetransMRT.seq,v 1.6 2008/08/29 06:26:00 ozoe Exp $
###############################################################################
BEGIN{
	$V6evalTool::TestVersion = '$Name: DHCPv6_Self_Test_P2_1_0_16 $';
}
use strict;
use V6evalTool;

use lib '../.';
use DHCPv6_common;
use Client_pktdesc;

dhcpExitNS  if ChkFuncSupport('STATELESSDHCP');

#--------------------------------------------------------------#
# Initialization variables
#--------------------------------------------------------------#
my $IF0_NUT = $V6evalTool::NutDef{"Link0_device"};
my $IF0 = "Link0";
my $timeout = 20;
my ($pretime, $nextime, $interval) =(0, 0, 0);
my $IRT = $INF_TIMEOUT;
vCapture($IF0);

#--------------------------------------------------------------#
# manuallly address configuration 
#--------------------------------------------------------------#
my $ret = initial_ra_w_ping($IF0,'ra_server2_to_all_addr_assign');
if($ret != 0){
	vLogHTML('<FONT COLOR="#FF0000">Global Address of NUT is not assigned by RA!</FONT><BR>');
	dhcpExitFail;
}
my $ret = vRemote("dhcp6c.rmt", "start", "inforeq", "dns", "link0=$IF0_NUT");
if($ret != 0) {
	vLogHTML('<FONT COLOR="#FF0000">Cannot Initialize DHCPv6 Client program.</FONT><BR>');
	dhcpExitFail;
};
#--------------------------------------------------------------#
# 1. Capture Information-request
#--------------------------------------------------------------#
my ($retinf1, %inf1) = wait_for_information_request($IF0, $timeout);

$ret = options_exist(\%inf1,$CMP_ETIME);
if($ret != 0){
	dhcpExitFail;
}

$pretime = getReceivedtime(\%inf1);
if($retinf1 != 0){
	dhcpExitFail;
}


#----------------------------------------------------------------------------#
#2. Capture the retransmitted message unitil RTprev = MRT + RAND*MRT
#----------------------------------------------------------------------------#
my $timeout = 0;
my ($retinf2, %inf2) = (1, ());
while(check_equal($interval,$INF_MAX_RT,$RAND)){
	if($interval > 0){
		$timeout = (2 + $RAND) * $interval;  
	}else{
		$timeout = (1 + $RAND) * $IRT;
	}
	($retinf2,%inf2) = wait_for_information_request($IF0, $timeout + 1);
	$nextime = getReceivedtime(\%inf2);
	if($retinf2 != 0){
		dhcpExitFail;
	}

	$interval = $nextime - $pretime;
	vLogHTML("<FONT COLOR=\"#FF0000\">RT = $interval <FONT><BR>");	
	if ($interval > $timeout) {
		vLogHTML("<FONT COLOR=\"#FF0000\">Actual RT is bigger than the expected maximum value<FONT><BR>");
		dhcpExitFail;
	}		
	$pretime = $nextime;
}
($retinf2,%inf2) = wait_for_information_request($IF0, $timeout);
$nextime = getReceivedtime(\%inf2);
if($retinf2 != 0){
	dhcpExitFail;
}
$interval = $nextime - $pretime;
if($interval > ($INF_MAX_RT + $RAND*$INF_MAX_RT)){
	vLogHTML("<FONT COLOR=\"#FF0000\">RT = $interval <FONT><BR>");
	dhcpExitFail;
}
#---------------------------
vLogHTML("<FONT COLOR=\"#FF0000\">RT = $interval</FONT><BR>");

#----------------------------------------------------------------------------#
#3. Compare the message with first message
#----------------------------------------------------------------------------#
$ret = compare_message(\%inf1,\%inf2);
if($ret != 0){
	vLogHTML('<FONT COLOR="#FF0000">Message has been changed !</FONT><BR>');
	dhcpExitFail;
}

vClear($IF0);
vStop($IF0);
dhcpExitPass;
###############################################################################
__END__

=head1 NAME 

  C_RFC3736_INfoRetransMRT.seq - MRT of Information-request message

=head1 TARGET

  Client

=head1 SYNOPSIS

=begin html
<PRE>
  <A HREF="./C_RFC3736_INfoRetransMRT.seq"> C_RFC3736_INfoRetransMRT.seq</A> [-tooloption...] <BR>  -pkt  <A HREF="./C_RFC3736_INfoRetransMRT.def"> C_RFC3736_INfoRetransMRT.def</A> <BR>  -tooloption : v6eval tool option
<BR>
  See Also <A HREF="../DHCPv6.def"> DHCPv6.def </A> 
</PRE>

=end html

=head1 INITIALIZATION

=begin html
  <ul>
  <li><STRONG>Network Topology</STRONG></li> 
    <PRE>
          NUT(Client) 3ffe:501:ffff:100::abcd            
          |                       
          |                       
Link0   --+--------+------------+---------- 3ffe:501:ffff:100::/64
                   |            |
                   |            |
                   TN(Server)   TN(DNS Server)
		                3ffe:501:ffff:100:200:ff:fe00:3f3e
    </PRE>
  </ul>  
  <ul>
  <li><STRONG>Verification Points</STRONG></li><br>
    <PRE>
   RT for each subsequent message transmission is based on the previous 
   value of RT:
     <BR>
     RT = 2*RTprev + RAND*RTprev
     <BR>
   MRT specifies an upper bound on the value of RT (disregarding the
   randomization added by the use of RAND).  
    <BR>
     if (RT > MRT)
       RT = MRT + RAND*MRT
    <BR>
    </PRE>
  </ul>
  <ul>  
  <li><STRONG>Configurations</STRONG></li><br>
   <BR>
    <TABLE BORDER="1">
    <TR>
    <TD><TT>Device Name</TT></TD>
    <TD><TT>Device Type</TT></TD>
    <TD><TT>Interface</TT></TD>
    <TD><TT>Assigned Prefix</TT></TD>
    <TD><TT>Link Local Addr</TT></TD>
    <TD><TT>MAC Addr</TT></TD>
    </TR>
    <TR>
    <TD><TT>Client</TT></TD>
    <TD><TT>NUT</TT></TD>
    <TD><TT>Link0</TT></TD>
    <TD><TT>3ffe:501:ffff:100::/64</TT></TD>
    <TD><TT>NUT's Linklocal address</TT></TD>
    <TD><TT>NUT's MAC address</TT></TD>
    </TR>
    <TR>
    <TD><TT>Server</TT></TD>
    <TD><TT>TN</TT></TD>
    <TD><TT>Link0</TT></TD>
    <TD><TT>3ffe:501:ffff:100::/64</TT></TD>
    <TD><TT>fe80::200:ff:fe00:a1a1</TT></TD>
    <TD><TT>00:00:00:00:a1:a1</TT></TD>
    </TR>
    </TABLE>
  </ul>

=end html

=head1 TEST PROCEDURE

=begin html
<PRE>
<BR>
       NUT      TN
        |       |
        |       | NUT has been configured with IPv6 address,
        |       | and request stateless DHCPv6 service
        |       |
        | ----> |<B>Information-request</B> w/Option Request Option(1*)
        |       |
        | ----> |<B>Information-request</B> w/Option Request Option(2*)
        .       .
        .       .until RTprev = MRT + MRT*RAND 
        |       |
        | ----> |<B>Information-request</B> w/Option Request Option(3*)
        |       |
<BR>
</PRE>

=end html

=head1 JUDGEMENT

=begin html
<PRE>
<BR>
  (3*)PASS: The RT must reach MRT. 
</PRE>

=end html

=head1 TERMINATION

=begin html
<PRE>
  N/A
</PRE>

=end html

=head1 REFERENCE

=begin html
<PRE>
  Also see RFC3315 Section 14 and 18.1.5
  Also see RFC3736
</PRE>

=end html

=head1 SEE ALSO

=begin html
<PRE>
<BR>
  perldoc  V6evalTool
<BR>
</PRE>

=end html