#!/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_RFC3315_18_1_2_CnfRetransMRT.seq,v 1.8 2008/04/02 08:19:41 miyata Exp $
###############################################################################
BEGIN{
	$V6evalTool::TestVersion = '$Name: DHCPv6_Self_Test_P2_1_0_14 $';
}
use strict;
use V6evalTool;

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

dhcpExitNS if(ChkFuncSupport('ADDRASSIGN') && ChkFuncSupport('DNS'));

#--------------------------------------------------------------#
# Initialization variables
#--------------------------------------------------------------#
my $IF0_NUT = $V6evalTool::NutDef{"Link0_device"};
my $IF0 = "Link0";
my ($pretime,$nextime) = (0, 0);
my ($start,$rd,$MRD) = (0,0,$CNF_MAX_RD);
#my $timeout = 2*$CNF_MAX_RT;
my $interval = 0;
my $rc = 0;
my $acceptablerange = 0;
my $startT2 = 0;
my $mrtflag = 0;
my $MAXCOUNT = 1;
my $FIRSTTIMEOUT = 5;

my $IRT = $CNF_TIMEOUT;
my $MRT = $CNF_MAX_RT;

vCapture($IF0);
#--------------------------------------------------------------#
# Initialize DHCPv6 Client
#--------------------------------------------------------------#
my $ret = initial_ra_w_ping($IF0,'ra_server2_to_all');
if($ret == 0){
	vLogHTML('<FONT COLOR="#FF0000">Global Address of NUT is assigned by RA!</FONT><BR>');
	dhcpExitFail;
}

$ret = vRemote("dhcp6c.rmt", "start", "iana", "iaid=111111", "link0=$IF0_NUT");
if($ret != 0) {
	vLogHTML('<FONT COLOR="#FF0000">Cannot Initialize DHCPv6 Client program.</FONT><BR>');
	dhcpExitFail;
};

#--------------------------------------------------------------#
#1.  Wait until Solicit arrives 
#--------------------------------------------------------------#
my ($retsol,%sol) = wait_for_solicit($IF0,30);
if($retsol != 0){
	dhcpExitFail;
}

#--------------------------------------------------------------#
#2. Send Advertise to reply to Solicit
#--------------------------------------------------------------#
$SID_OPTION = "opt_SID_LLT_server1";
$IA_NA_OPTION = "opt_IA_NA_Addr_woStatus";
my ($retadv, %adv) = send_advertise($IF0, "advertise_server1_to_nut", \%sol, "");
if($retadv != 0){
	dhcpExitFail;
}

#--------------------------------------------------------------#
#3.  Wait until Request arrives 
#--------------------------------------------------------------#
my ($retreq, %req) = wait_for_request($IF0,30);
if($retreq != 0){
	dhcpExitFail;
}

#--------------------------------------------------------------#
#4. send Reply message
#--------------------------------------------------------------#
$StatusCode_OPTION = "opt_StatusCode";
my ($retrep, %rep) = send_reply($IF0, "reply_server1_to_nut", \%req, "");
if($retrep !=0){
	dhcpExitFail;
}

# wait for DAD completion
vRecv($IF0, 3, 0, 0, 'dadns_nutga');
vSleep(3);

$ret = undef;
$ret = ping_test($IF0);
if($ret != 0){
	dhcpExitFail;
}

vClear($IF0);
#--------------------------------------------------------------#
# Restart DHCP Client
#--------------------------------------------------------------#
#dhcpCltRestart();
#$ret = undef;
#$ret = vRemoteAsync("dhcp6c.rmt", "restart", "link0=$IF0_NUT");
#if($ret != 0) {
#	vLogHTML('<FONT COLOR="#FF0000">Cannot Restart DHCPv6 Client.</FONT><BR>');
#	vRemoteAsyncWait();
#	dhcpExitFail;
#};

# interface up/down
ifDown($IF0_NUT);
vSleep(5);
ifUp($IF0_NUT);
#--------------------------------------------------------------#
#5. Wait until confirm arrives 
#--------------------------------------------------------------#
my ($retcnf1,%cnf1) = wait_for_confirm($IF0, $FIRSTTIMEOUT);
if($retcnf1 != 0){
#	vRemoteAsyncWait();
	dhcpExitFail;
}

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

$pretime = getReceivedtime(\%cnf1); 
$start = $pretime;
vClear($IF0);

#--------------------------------------------------------------#
#6. Wait until retransmitted message arrives 
#--------------------------------------------------------------#
my $timeout = 0;
my $initflag = 0;
my ($retcnf2, %cnf2) = (1, undef);

vLogHTML('<PRE>');
vLogHTML("<FONT COLOR=\"#FF0000\">IRT is $IRT sec, MRT is $MRT sec, MRD is $MRD sec</FONT><BR>");
vLogHTML('<FONT COLOR="#FF0000">Retransmitted Maximum Request RT.</FONT><BR>');
vLogHTML('<FONT COLOR="#FF0000">1st 2nd  3rd</FONT><BR>');
vLogHTML('<FONT COLOR="#FF0000">1.1 2.31 4.4</FONT><BR>');
vLogHTML('</PRE>');

while($mrtflag < $MAXCOUNT){
	if($initflag != 0){
		$timeout = (2 + $RAND) * $interval;  
	}else{
		$timeout = (1 + $RAND) * $IRT;
	}
	$initflag=1;

	# If $timeout is bigger than MRT, expected RT is MRT + RAND * MRT
	if($timeout > $MRT){
		$timeout = (1 + $RAND) * $MRT;
	}

#
#----------- Wait for next retransmission
#
	($retcnf2,%cnf2) = wait_for_confirm($IF0, $timeout + 1);
	if($retcnf2 != 0){
		dhcpExitFail;
	}

        $ret = compare_message(\%cnf1,\%cnf2);
        if($ret != 0){
                vLogHTML('<FONT COLOR="#FF0000">Message has been changed!</FONT><BR>');
                dhcpExitFail;
        }

#
#----------- Calcurate current RT
#
 
	$nextime = getReceivedtime(\%cnf2); 
	$rd = $nextime - $start;
	$interval = $nextime - $pretime;
	$pretime = $nextime;

	vLogHTML("<FONT COLOR=\"#FF0000\">Actual RT is $interval, RD is $rd sec  <FONT><BR>");
	if ($interval > $timeout) {
		vLogHTML("<FONT COLOR=\"#FF0000\">Actual RT is bigger than the expected maximum value<FONT><BR>");
		dhcpExitFail;
	}	

#
#----------- MRD Expiration, but it must not happen
#
	if($rd > $MRD){
		vLogHTML('<FONT COLOR="#FF0000">MRD exceeds! </FONT><BR>');
		dhcpExitFail;
	}
#
#----------- Check if RT satisfies RT = MRT(1+RAND)
#
	if(!check_equal($interval,$MRT,$RAND)){
		$mrtflag += 1;
	}

}

vLogHTML('<FONT COLOR="#FF0000">RT = MRT(1+RAND) observed</FONT><BR>');

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

##NEEDCHECK
###############################################################################
__END__

=head1 NAME 

  C_RFC3315_18_1_2_CnfRetransMRT.seq - Check MRT of Confirm

=head1 TARGET

  Client

=head1 SYNOPSIS

=begin html
<PRE>
  <A HREF="./C_RFC3315_18_1_2_CnfRetransMRT.seq"> C_RFC3315_18_1_2_CnfRetransMRT.seq</A> [-tooloption...] <BR>  -pkt  <A HREF="./C_RFC3315_18_1_2_CnfRetransMRT.def"> C_RFC3315_18_1_2_CnfRetransMRT.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)
          |           
          |                        
Link0   --+--------+------------------------ 3ffe:501:ffff:100::/64
                   |
                   |          
                   TN(Server) 
   </PRE>
  </ul>
  <ul>  
  <li><STRONG>Verification Points</STRONG></li><br>
   <PRE>
   The client transmits the message using the following parameters:
     IRT   CNF_TIMEOUT  <BR>
     MRT   CNF_MAX_RT   <BR>
     MRC   0            <BR>
     MRD   CNF_MAX_RD   <BR>
   RT for each transmission is based on the previous value of RT: <BR>
     RT = 2*RTprev + RAND*RTprev. <BR>
   If (RT > MRT) <BR>
     <B>RT = MRT + RAND*MRT</B>.  
   </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
        |       | 
        |       |Initialize NUT(as a DHCPv6 client)
        |       |
        | ----> |<B>Solicit</B> 
        | <---- |<B>Advertise</B> 
        | ----> |<B>Request</B> 
        | <---- |<B>Reply</B> 
        |       |
        | <---- |<B>Echo Request</B>
        | ----> |<B>Echo Reply</B>
        |       |	 
        |       |Restart NUT (or Interface down/up)
        |       |
        | ----> |<B>Confirm</B>
        |       |
        .       .Waiting for retransmission until RT = MRT + RAND*MRT
        |       |
        | ----> |<B>Confirm</B> (8*)
        |       |
</PRE>

=end html

=head1 JUDGEMENT

=begin html
<PRE>
  (8*)PASS: TN receives retransmitted Confirm.
            And RT conforms to Verification Points.
</PRE>

=end html

=head1 TERMINATION

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

=end html

=head1 REFERENCE

=begin html
<PRE>
  Also see RFC3315
<BR>  
  18.1.2. Creation and Transmission of Confirm Messages
<BR>
</PRE>

=end html

=head1 SEE ALSO

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

=end html